Skip to content

CatalogChangesApi.md

Latest commit

 

History

History
210 lines (159 loc) · 6.79 KB

CatalogChangesApi.md

File metadata and controls

210 lines (159 loc) · 6.79 KB

Flipdish.Api.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 (string appId, int? menuId = null, string catalogItemId = null, int? page = null, int? limit = null)

Get menu pending changes from Catalog groups and items

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

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPendingMenuChangesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogChangesApi();
            var appId = appId_example;  // string | 
            var menuId = 56;  // int? |  (optional) 
            var catalogItemId = catalogItemId_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                // Get menu pending changes from Catalog groups and items
                RestApiPaginationResultPendingMenuChanges result = apiInstance.GetPendingMenuChanges(appId, menuId, catalogItemId, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogChangesApi.GetPendingMenuChanges: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
menuId int? [optional]
catalogItemId string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultPendingMenuChanges

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPendingMenuChangesSummaries

RestApiArrayResultPendingMenuChangesSummaries GetPendingMenuChangesSummaries (string appId)

Get menu pending changes summaries by appId

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPendingMenuChangesSummariesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogChangesApi();
            var appId = appId_example;  // string | 

            try
            {
                // Get menu pending changes summaries by appId
                RestApiArrayResultPendingMenuChangesSummaries result = apiInstance.GetPendingMenuChangesSummaries(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogChangesApi.GetPendingMenuChangesSummaries: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublishPendingMenuChanges

void PublishPendingMenuChanges (string appId, PublishMenuChanges 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

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class PublishPendingMenuChangesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogChangesApi();
            var appId = appId_example;  // string | 
            var publishMenuChanges = new PublishMenuChanges(); // PublishMenuChanges | 

            try
            {
                // Update menus with the pending changes from Catalog groups and items
                apiInstance.PublishPendingMenuChanges(appId, publishMenuChanges);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogChangesApi.PublishPendingMenuChanges: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
publishMenuChanges PublishMenuChanges

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]