# ps.module.BrandApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionBrandExternalvettingIdPut**](BrandApi.md#apiVersionBrandExternalvettingIdPut) | **PUT** /api/{version}/brand/externalvetting/{id} | Request brand vetting
[**apiVersionBrandGet**](BrandApi.md#apiVersionBrandGet) | **GET** /api/{version}/brand | List brand
[**apiVersionBrandIdDelete**](BrandApi.md#apiVersionBrandIdDelete) | **DELETE** /api/{version}/brand/{id} | Delete brand
[**apiVersionBrandIdGet**](BrandApi.md#apiVersionBrandIdGet) | **GET** /api/{version}/brand/{id} | Get brand
[**apiVersionBrandIdPut**](BrandApi.md#apiVersionBrandIdPut) | **PUT** /api/{version}/brand/{id} | Update brand
[**apiVersionBrandIdRevetPut**](BrandApi.md#apiVersionBrandIdRevetPut) | **PUT** /api/{version}/brand/{id}/revet | Revet Brand
[**apiVersionBrandPost**](BrandApi.md#apiVersionBrandPost) | **POST** /api/{version}/brand | Create brand
[**apiVersionBrandSyncGet**](BrandApi.md#apiVersionBrandSyncGet) | **GET** /api/{version}/brand/sync | Brand Sync From User (Required Identity Login)
[**apiVersionBrandSyncdataGet**](BrandApi.md#apiVersionBrandSyncdataGet) | **GET** /api/{version}/brand/syncdata | Brand Sync Data From CloudFlare Require Key Access

<a name="apiVersionBrandExternalvettingIdPut"></a>
# **apiVersionBrandExternalvettingIdPut**
> apiVersionBrandExternalvettingIdPut(idversion)

Request brand vetting

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBrandExternalvettingIdPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBrandsRequestExternalVettingBrandQuery**](PhoneSpeakServiceCoreBrandsRequestExternalVettingBrandQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBrandGet"></a>
# **apiVersionBrandGet**
> apiVersionBrandGet(version, opts)

List brand

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let version = "version_example"; // String | 
let opts = { 
  'tenantId': "tenantId_example", // String | 
  'identityStatus': new ps.module.PhoneSpeakEntitiesEnumsTelcoIdentityStatus(), // PhoneSpeakEntitiesEnumsTelcoIdentityStatus | 
  'isVerified': true, // Boolean | 
  'sortBy': "sortBy_example", // String | 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // PhoneSpeakEntitiesEnumsListDirection | 
  'search': "search_example", // String | 
  'limit': 56, // Number | 
  'pageNum': 56 // Number | 
};
apiInstance.apiVersionBrandGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **tenantId** | **String**|  | [optional] 
 **identityStatus** | [**PhoneSpeakEntitiesEnumsTelcoIdentityStatus**](.md)|  | [optional] 
 **isVerified** | **Boolean**|  | [optional] 
 **sortBy** | **String**|  | [optional] 
 **direction** | [**PhoneSpeakEntitiesEnumsListDirection**](.md)|  | [optional] 
 **search** | **String**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **pageNum** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBrandIdDelete"></a>
# **apiVersionBrandIdDelete**
> apiVersionBrandIdDelete(id, version)

Delete brand

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBrandIdDelete(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBrandIdGet"></a>
# **apiVersionBrandIdGet**
> apiVersionBrandIdGet(id, version)

Get brand

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBrandIdGet(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBrandIdPut"></a>
# **apiVersionBrandIdPut**
> apiVersionBrandIdPut(idversion)

Update brand

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBrandIdPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBrandsUpdateBrandQuery**](PhoneSpeakServiceCoreBrandsUpdateBrandQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBrandIdRevetPut"></a>
# **apiVersionBrandIdRevetPut**
> apiVersionBrandIdRevetPut(idversion)

Revet Brand

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBrandIdRevetPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBrandsRevetBrandQuery**](PhoneSpeakServiceCoreBrandsRevetBrandQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBrandPost"></a>
# **apiVersionBrandPost**
> apiVersionBrandPost(version)

Create brand

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let version = "version_example"; // String | 

apiInstance.apiVersionBrandPost(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBrandsCreateBrandQuery**](PhoneSpeakServiceCoreBrandsCreateBrandQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBrandSyncGet"></a>
# **apiVersionBrandSyncGet**
> apiVersionBrandSyncGet(version, opts)

Brand Sync From User (Required Identity Login)

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BrandApi();
let version = "version_example"; // String | 
let opts = { 
  'tenantId': "tenantId_example", // String | 
  'brandId': "brandId_example" // String | 
};
apiInstance.apiVersionBrandSyncGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **tenantId** | **String**|  | [optional] 
 **brandId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBrandSyncdataGet"></a>
# **apiVersionBrandSyncdataGet**
> apiVersionBrandSyncdataGet(version, opts)

Brand Sync Data From CloudFlare Require Key Access

### Example
```javascript
import ps.module from 'phonespeakv2_api';

let apiInstance = new ps.module.BrandApi();
let version = "version_example"; // String | 
let opts = { 
  'tenantId': "tenantId_example", // String | 
  'brandId': "brandId_example" // String | 
};
apiInstance.apiVersionBrandSyncdataGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **tenantId** | **String**|  | [optional] 
 **brandId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined