Skip to content

WhiteLabelConfigApi.md

Latest commit

 

History

History
492 lines (319 loc) · 13.1 KB

WhiteLabelConfigApi.md

File metadata and controls

492 lines (319 loc) · 13.1 KB
Raw

Flipdish.WhiteLabelConfigApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
getAppGeneralConfig GET /api/v1.0/whitelabelconfig/{appId}/general
getPlayStoreConfig GET /api/v1.0/whitelabelconfig/{appId}/playstore
getWhiteLabelAppStoreConfig GET /api/v1.0/whitelabelconfig/{appId}/appstore
getWhiteLabelConfig GET /api/v1.0/whitelabelconfig/id/{wlid}
getWhiteLabelConfigByAppNameId GET /api/v1.0/whitelabelconfig/name/{appId}
updateAppGeneralConfig POST /api/v1.0/whitelabelconfig/{appId}/general
updatePlayStoreConfig POST /api/v1.0/whitelabelconfig/{appId}/playstore
updateWhiteLabelAppStoreConfig POST /api/v1.0/whitelabelconfig/{appId}/appstore
uploadAppStoreIcon POST /api/v1.0/whitelabelconfig/{appId}/app-store-icon
whiteLabelConfigHealthCheck GET /api/v1.0/whitelabelconfig/health

getAppGeneralConfig

RestApiResultAppGeneralConfigModel getAppGeneralConfig(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
apiInstance.getAppGeneralConfig(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultAppGeneralConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getPlayStoreConfig

RestApiResultPlayStoreConfigModel getPlayStoreConfig(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
apiInstance.getPlayStoreConfig(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultPlayStoreConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getWhiteLabelAppStoreConfig

RestApiResultAppStoreConfigModel getWhiteLabelAppStoreConfig(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
apiInstance.getWhiteLabelAppStoreConfig(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultAppStoreConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getWhiteLabelConfig

RestApiResultWhiteLabelConfigModel getWhiteLabelConfig(wlid)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let wlid = 56; // Number | 
apiInstance.getWhiteLabelConfig(wlid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
wlid Number

Return type

RestApiResultWhiteLabelConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getWhiteLabelConfigByAppNameId

RestApiResultWhiteLabelConfigModel getWhiteLabelConfigByAppNameId(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
apiInstance.getWhiteLabelConfigByAppNameId(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultWhiteLabelConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

updateAppGeneralConfig

RestApiResultAppGeneralConfigModel updateAppGeneralConfig(appId, appGeneralConfig)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
let appGeneralConfig = new Flipdish.AppGeneralConfigModel(); // AppGeneralConfigModel | 
apiInstance.updateAppGeneralConfig(appId, appGeneralConfig, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appGeneralConfig AppGeneralConfigModel

Return type

RestApiResultAppGeneralConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

updatePlayStoreConfig

RestApiResultPlayStoreConfigModel updatePlayStoreConfig(appId, playStoreConfig)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
let playStoreConfig = new Flipdish.PlayStoreConfigModel(); // PlayStoreConfigModel | 
apiInstance.updatePlayStoreConfig(appId, playStoreConfig, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
playStoreConfig PlayStoreConfigModel

Return type

RestApiResultPlayStoreConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

updateWhiteLabelAppStoreConfig

RestApiResultAppStoreConfigModel updateWhiteLabelAppStoreConfig(appId, appStoreConfig)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
let appStoreConfig = new Flipdish.AppStoreConfigModel(); // AppStoreConfigModel | 
apiInstance.updateWhiteLabelAppStoreConfig(appId, appStoreConfig, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appStoreConfig AppStoreConfigModel

Return type

RestApiResultAppStoreConfigModel

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

uploadAppStoreIcon

RestApiResultAssetResultModel uploadAppStoreIcon(appId, file)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
let appId = "appId_example"; // String | 
let file = new Flipdish.HttpPostedFileBase(); // HttpPostedFileBase | 
apiInstance.uploadAppStoreIcon(appId, file, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
file HttpPostedFileBase

Return type

RestApiResultAssetResultModel

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

whiteLabelConfigHealthCheck

String whiteLabelConfigHealthCheck()

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.WhiteLabelConfigApi();
apiInstance.whiteLabelConfigHealthCheck((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml