Skip to content

OnboardingApi.md

Latest commit

 

History

History
424 lines (284 loc) · 11.3 KB

OnboardingApi.md

File metadata and controls

424 lines (284 loc) · 11.3 KB
Raw

Flipdish.OnboardingApi

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

Method HTTP request Description
onboardingGetOnboardingConfig GET /api/v1.0/clients/{appId}/onboarding/config
onboardingGetOnboardingConfigs GET /api/v1.0/clients/{appId}/onboarding/configs
onboardingGetOnboardingItems GET /api/v1.0/clients/{appId}/onboarding/stores/{storeId}
onboardingGetOnboardingItemsV2 GET /api/v1.0/clients/{appId}/onboarding/stores
onboardingUpdateOnboardingConfig POST /api/v1.0/clients/{appId}/onboarding/config
onboardingUpdateOnboardingConfigById POST /api/v1.0/clients/{appId}/onboarding/config/{configId}
onboardingUpdateOnboardingItem POST /api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}
onboardingUpdateOnboardingItemV2 POST /api/v1.0/clients/{appId}/onboarding/stores/items/{onboardingItemId}

onboardingGetOnboardingConfig

Object onboardingGetOnboardingConfig(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.OnboardingApi();
let appId = "appId_example"; // String | 
apiInstance.onboardingGetOnboardingConfig(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

Object

Authorization

oauth2

HTTP request headers

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

onboardingGetOnboardingConfigs

Object onboardingGetOnboardingConfigs(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.OnboardingApi();
let appId = "appId_example"; // String | 
apiInstance.onboardingGetOnboardingConfigs(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

Object

Authorization

oauth2

HTTP request headers

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

onboardingGetOnboardingItems

Object onboardingGetOnboardingItems(appId, storeId, opts)

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.OnboardingApi();
let appId = "appId_example"; // String | 
let storeId = 56; // Number | 
let opts = {
  'milestoneId': 56 // Number | 
};
apiInstance.onboardingGetOnboardingItems(appId, storeId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
storeId Number
milestoneId Number [optional]

Return type

Object

Authorization

oauth2

HTTP request headers

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

onboardingGetOnboardingItemsV2

Object onboardingGetOnboardingItemsV2(appId, opts)

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.OnboardingApi();
let appId = "appId_example"; // String | 
let opts = {
  'storeId': 56, // Number | 
  'milestoneId': 56 // Number | 
};
apiInstance.onboardingGetOnboardingItemsV2(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
storeId Number [optional]
milestoneId Number [optional]

Return type

Object

Authorization

oauth2

HTTP request headers

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

onboardingUpdateOnboardingConfig

Object onboardingUpdateOnboardingConfig(appId, configUpdate)

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.OnboardingApi();
let appId = "appId_example"; // String | 
let configUpdate = new Flipdish.OnboardingConfigUpdate(); // OnboardingConfigUpdate | 
apiInstance.onboardingUpdateOnboardingConfig(appId, configUpdate, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
configUpdate OnboardingConfigUpdate

Return type

Object

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

onboardingUpdateOnboardingConfigById

Object onboardingUpdateOnboardingConfigById(appId, configId, configUpdate)

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.OnboardingApi();
let appId = "appId_example"; // String | 
let configId = 56; // Number | 
let configUpdate = new Flipdish.OnboardingConfigUpdate(); // OnboardingConfigUpdate | 
apiInstance.onboardingUpdateOnboardingConfigById(appId, configId, configUpdate, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
configId Number
configUpdate OnboardingConfigUpdate

Return type

Object

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

onboardingUpdateOnboardingItem

Object onboardingUpdateOnboardingItem(appId, storeId, onboardingItemId, itemUpdate)

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.OnboardingApi();
let appId = "appId_example"; // String | 
let storeId = 56; // Number | 
let onboardingItemId = 56; // Number | 
let itemUpdate = new Flipdish.OnboardingItemUpdate(); // OnboardingItemUpdate | 
apiInstance.onboardingUpdateOnboardingItem(appId, storeId, onboardingItemId, itemUpdate, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
storeId Number
onboardingItemId Number
itemUpdate OnboardingItemUpdate

Return type

Object

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

onboardingUpdateOnboardingItemV2

Object onboardingUpdateOnboardingItemV2(appId, onboardingItemId, itemUpdate, opts)

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.OnboardingApi();
let appId = "appId_example"; // String | 
let onboardingItemId = 56; // Number | 
let itemUpdate = new Flipdish.OnboardingItemUpdate(); // OnboardingItemUpdate | 
let opts = {
  'storeId': 56 // Number | 
};
apiInstance.onboardingUpdateOnboardingItemV2(appId, onboardingItemId, itemUpdate, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
onboardingItemId Number
itemUpdate OnboardingItemUpdate
storeId Number [optional]

Return type

Object

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