Skip to content

Latest commit

 

History

History
177 lines (129 loc) · 5.91 KB

CatalogChangesApi.md

File metadata and controls

177 lines (129 loc) · 5.91 KB

CatalogChangesApi

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

Method HTTP request Description
getPendingMenuChanges GET /api/v1.0/{appId}/menus/catalog-changes Get menu pending changes from Catalog groups and items
getPendingMenuChangesSummaries GET /api/v1.0/{appId}/menus/catalog-changes/summaries Get menu pending changes summaries by appId
publishPendingMenuChanges POST /api/v1.0/{appId}/menus/catalog-changes/publish Update menus with the pending changes from Catalog groups and items

getPendingMenuChanges

RestApiPaginationResultPendingMenuChanges getPendingMenuChanges(appId, menuId, catalogItemId, page, limit)

Get menu pending changes from Catalog groups and items

[BETA - this endpoint is under development, do not use it in your production system]

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.CatalogChangesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

CatalogChangesApi apiInstance = new CatalogChangesApi();
String appId = "appId_example"; // String | 
Integer menuId = 56; // Integer | 
String catalogItemId = "catalogItemId_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultPendingMenuChanges result = apiInstance.getPendingMenuChanges(appId, menuId, catalogItemId, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogChangesApi#getPendingMenuChanges");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
menuId Integer [optional]
catalogItemId String [optional]
page Integer [optional]
limit Integer [optional]

Return type

RestApiPaginationResultPendingMenuChanges

Authorization

oauth2

HTTP request headers

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

getPendingMenuChangesSummaries

RestApiArrayResultPendingMenuChangesSummaries getPendingMenuChangesSummaries(appId)

Get menu pending changes summaries by 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.CatalogChangesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultPendingMenuChangesSummaries

Authorization

oauth2

HTTP request headers

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

publishPendingMenuChanges

publishPendingMenuChanges(appId, publishMenuChanges)

Update menus with the pending changes from Catalog groups and items

[BETA - this endpoint is under development, do not use it in your production system]

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.CatalogChangesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

CatalogChangesApi apiInstance = new CatalogChangesApi();
String appId = "appId_example"; // String | 
PublishMenuChanges publishMenuChanges = new PublishMenuChanges(); // PublishMenuChanges | 
try {
    apiInstance.publishPendingMenuChanges(appId, publishMenuChanges);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogChangesApi#publishPendingMenuChanges");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
publishMenuChanges PublishMenuChanges

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