Skip to content

Latest commit

 

History

History
450 lines (326 loc) · 13.8 KB

OnboardingApi.md

File metadata and controls

450 lines (326 loc) · 13.8 KB

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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
try {
    Object result = apiInstance.onboardingGetOnboardingConfig(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingGetOnboardingConfig");
    e.printStackTrace();
}

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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
try {
    Object result = apiInstance.onboardingGetOnboardingConfigs(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingGetOnboardingConfigs");
    e.printStackTrace();
}

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, milestoneId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
Integer milestoneId = 56; // Integer | 
try {
    Object result = apiInstance.onboardingGetOnboardingItems(appId, storeId, milestoneId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingGetOnboardingItems");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer
milestoneId Integer [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, storeId, milestoneId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
Integer milestoneId = 56; // Integer | 
try {
    Object result = apiInstance.onboardingGetOnboardingItemsV2(appId, storeId, milestoneId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingGetOnboardingItemsV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer [optional]
milestoneId Integer [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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
OnboardingConfigUpdate configUpdate = new OnboardingConfigUpdate(); // OnboardingConfigUpdate | 
try {
    Object result = apiInstance.onboardingUpdateOnboardingConfig(appId, configUpdate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingUpdateOnboardingConfig");
    e.printStackTrace();
}

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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
Integer configId = 56; // Integer | 
OnboardingConfigUpdate configUpdate = new OnboardingConfigUpdate(); // OnboardingConfigUpdate | 
try {
    Object result = apiInstance.onboardingUpdateOnboardingConfigById(appId, configId, configUpdate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingUpdateOnboardingConfigById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
configId Integer
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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
Integer onboardingItemId = 56; // Integer | 
OnboardingItemUpdate itemUpdate = new OnboardingItemUpdate(); // OnboardingItemUpdate | 
try {
    Object result = apiInstance.onboardingUpdateOnboardingItem(appId, storeId, onboardingItemId, itemUpdate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingUpdateOnboardingItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer
onboardingItemId Integer
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, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OnboardingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OnboardingApi apiInstance = new OnboardingApi();
String appId = "appId_example"; // String | 
Integer onboardingItemId = 56; // Integer | 
OnboardingItemUpdate itemUpdate = new OnboardingItemUpdate(); // OnboardingItemUpdate | 
Integer storeId = 56; // Integer | 
try {
    Object result = apiInstance.onboardingUpdateOnboardingItemV2(appId, onboardingItemId, itemUpdate, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OnboardingApi#onboardingUpdateOnboardingItemV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
onboardingItemId Integer
itemUpdate OnboardingItemUpdate
storeId Integer [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