Skip to content

AppStoreConfigurationsApi.md

Latest commit

 

History

History
470 lines (313 loc) · 14 KB

AppStoreConfigurationsApi.md

File metadata and controls

470 lines (313 loc) · 14 KB
Raw

Flipdish.AppStoreConfigurationsApi

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

Method HTTP request Description
appStoreConfigurationsAppStoreHandleOauthResponseCode GET /api/v1.0/appstore/oauthresponse/{appStoreAppId}/responsecode
createAppStoreConfig POST /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config
deleteAppStoreConfig DELETE /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
executeConfigurationAction POST /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/action
getAppStoreConfig GET /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
getConfiguredAppSingleApp GET /api/v1.0/{appId}/appstore/apps/{appStoreAppId}
getConfiguredApps GET /api/v1.0/{appId}/appstore/apps
updateAppStoreConfig PUT /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
updateAppStoreConfigSettingValues POST /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/updatesettings

appStoreConfigurationsAppStoreHandleOauthResponseCode

Object appStoreConfigurationsAppStoreHandleOauthResponseCode(appStoreAppId)

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.AppStoreConfigurationsApi();
let appStoreAppId = "appStoreAppId_example"; // String | 
apiInstance.appStoreConfigurationsAppStoreHandleOauthResponseCode(appStoreAppId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appStoreAppId String

Return type

Object

Authorization

oauth2

HTTP request headers

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

createAppStoreConfig

RestApiResultAppStoreAppConfiguration createAppStoreConfig(appId, appStoreAppId)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
apiInstance.createAppStoreConfig(appId, appStoreAppId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String

Return type

RestApiResultAppStoreAppConfiguration

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

deleteAppStoreConfig

RestApiStringResult deleteAppStoreConfig(appId, appStoreAppId, configId)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
let configId = "configId_example"; // String | 
apiInstance.deleteAppStoreConfig(appId, appStoreAppId, configId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String
configId String

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

executeConfigurationAction

RestApiResultExecuteConfigurationActionResult executeConfigurationAction(appId, appStoreAppId, configId, executeConfigurationActionRequest)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
let configId = "configId_example"; // String | 
let executeConfigurationActionRequest = new Flipdish.ExecuteConfigurationActionRequest(); // ExecuteConfigurationActionRequest | 
apiInstance.executeConfigurationAction(appId, appStoreAppId, configId, executeConfigurationActionRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String
configId String
executeConfigurationActionRequest ExecuteConfigurationActionRequest

Return type

RestApiResultExecuteConfigurationActionResult

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, Data

getAppStoreConfig

RestApiResultAppStoreAppConfiguration getAppStoreConfig(appId, appStoreAppId, configId)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
let configId = "configId_example"; // String | 
apiInstance.getAppStoreConfig(appId, appStoreAppId, configId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String
configId String

Return type

RestApiResultAppStoreAppConfiguration

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

getConfiguredAppSingleApp

RestApiArrayResultAppStoreAppConfigurationSummary getConfiguredAppSingleApp(appId, appStoreAppId)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
apiInstance.getConfiguredAppSingleApp(appId, appStoreAppId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String

Return type

RestApiArrayResultAppStoreAppConfigurationSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

getConfiguredApps

RestApiArrayResultAppStoreAppSummary getConfiguredApps(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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
apiInstance.getConfiguredApps(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

RestApiArrayResultAppStoreAppSummary

Authorization

oauth2

HTTP request headers

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

updateAppStoreConfig

updateAppStoreConfig(appId, appStoreAppId, configId, updateAppStoreAppConfiguration)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
let configId = "configId_example"; // String | 
let updateAppStoreAppConfiguration = new Flipdish.UpdateAppStoreAppConfiguration(); // UpdateAppStoreAppConfiguration | 
apiInstance.updateAppStoreConfig(appId, appStoreAppId, configId, updateAppStoreAppConfiguration, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String
configId String
updateAppStoreAppConfiguration UpdateAppStoreAppConfiguration

Return type

null (empty response body)

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, Message, ErrorCode, StackTrace

updateAppStoreConfigSettingValues

updateAppStoreConfigSettingValues(appId, appStoreAppId, configId, updateAppStoreAppConfigurationValues)

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.AppStoreConfigurationsApi();
let appId = "appId_example"; // String | 
let appStoreAppId = "appStoreAppId_example"; // String | 
let configId = "configId_example"; // String | 
let updateAppStoreAppConfigurationValues = new Flipdish.UpdateAppStoreAppConfigurationValuesBatch(); // UpdateAppStoreAppConfigurationValuesBatch | 
apiInstance.updateAppStoreConfigSettingValues(appId, appStoreAppId, configId, updateAppStoreAppConfigurationValues, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
appStoreAppId String
configId String
updateAppStoreAppConfigurationValues UpdateAppStoreAppConfigurationValuesBatch

Return type

null (empty response body)

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, Message, ErrorCode, StackTrace