Skip to content

Latest commit

 

History

History
750 lines (580 loc) · 24.9 KB

MenuSectionItemsApi.md

File metadata and controls

750 lines (580 loc) · 24.9 KB

Flipdish.Api.MenuSectionItemsApi

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

Method HTTP request Description
CloneMenuSectionItem POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/clone Clone menu section item
CreateMenuSectionItem POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems Create menu section item
CreateMenuSectionItemFromCatalogItems POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/add-catalogitems Create menu section items from a list of Catalog Items
DeleteMenuSectionItem DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId} Delete menu section item
DeleteMenuSectionItemImage DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image Delete menu section item image
GetMenuItemById GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId} Get menu item by identifier
GetMenuItems GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems Get menu items
MoveMenuItem POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/setorder/{destinationDisplayOrder} Move an Item within a menu
SetSectionItemTax POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/taxrate/{taxRateId} Set tax rate for menu item
UpdateMenuSectionItem POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId} Update menu section item
UploadMenuSectionItemImage POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image Upload menu section item image

CloneMenuSectionItem

RestApiResultMenuSectionItem CloneMenuSectionItem (int? menuId, int? menuSectionId, int? menuSectionItemId)

Clone menu section item

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier

            try
            {
                // Clone menu section item
                RestApiResultMenuSectionItem result = apiInstance.CloneMenuSectionItem(menuId, menuSectionId, menuSectionItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.CloneMenuSectionItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier

Return type

RestApiResultMenuSectionItem

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]

CreateMenuSectionItem

Object CreateMenuSectionItem (int? menuId, int? menuSectionId, MenuSectionItemBase menuSectionItem)

Create menu section item

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItem = new MenuSectionItemBase(); // MenuSectionItemBase | Menu section item

            try
            {
                // Create menu section item
                Object result = apiInstance.CreateMenuSectionItem(menuId, menuSectionId, menuSectionItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.CreateMenuSectionItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItem MenuSectionItemBase Menu section item

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

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

CreateMenuSectionItemFromCatalogItems

Object CreateMenuSectionItemFromCatalogItems (int? menuId, int? menuSectionId, CreateMenuSectionItemFromCatalogItems createFromCatalogItems)

Create menu section items from a list of Catalog 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 CreateMenuSectionItemFromCatalogItemsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var createFromCatalogItems = new CreateMenuSectionItemFromCatalogItems(); // CreateMenuSectionItemFromCatalogItems | Information to create the new MenuSectionItems

            try
            {
                // Create menu section items from a list of Catalog Items
                Object result = apiInstance.CreateMenuSectionItemFromCatalogItems(menuId, menuSectionId, createFromCatalogItems);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.CreateMenuSectionItemFromCatalogItems: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
createFromCatalogItems CreateMenuSectionItemFromCatalogItems Information to create the new MenuSectionItems

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

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

DeleteMenuSectionItem

void DeleteMenuSectionItem (int? menuId, int? menuSectionId, int? menuSectionItemId)

Delete menu section item

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier

            try
            {
                // Delete menu section item
                apiInstance.DeleteMenuSectionItem(menuId, menuSectionId, menuSectionItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.DeleteMenuSectionItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier

Return type

void (empty response body)

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]

DeleteMenuSectionItemImage

void DeleteMenuSectionItemImage (int? menuId, int? menuSectionId, int? menuSectionItemId)

Delete menu section item image

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier

            try
            {
                // Delete menu section item image
                apiInstance.DeleteMenuSectionItemImage(menuId, menuSectionId, menuSectionItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.DeleteMenuSectionItemImage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier

Return type

void (empty response body)

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]

GetMenuItemById

RestApiResultMenuSectionItem GetMenuItemById (int? menuId, int? menuSectionId, int? menuSectionItemId)

Get menu item by identifier

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu item identifier

            try
            {
                // Get menu item by identifier
                RestApiResultMenuSectionItem result = apiInstance.GetMenuItemById(menuId, menuSectionId, menuSectionItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.GetMenuItemById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu item identifier

Return type

RestApiResultMenuSectionItem

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]

GetMenuItems

RestApiArrayResultMenuSectionItem GetMenuItems (int? menuId, int? menuSectionId)

Get menu items

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier

            try
            {
                // Get menu items
                RestApiArrayResultMenuSectionItem result = apiInstance.GetMenuItems(menuId, menuSectionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.GetMenuItems: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier

Return type

RestApiArrayResultMenuSectionItem

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]

MoveMenuItem

void MoveMenuItem (int? menuId, int? menuSectionId, int? menuSectionItemId, int? destinationDisplayOrder)

Move an Item within a menu

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Section to put item in (will usually be original section)
            var menuSectionItemId = 56;  // int? | ID of Item to be moved
            var destinationDisplayOrder = 56;  // int? | New Display Order of item

            try
            {
                // Move an Item within a menu
                apiInstance.MoveMenuItem(menuId, menuSectionId, menuSectionItemId, destinationDisplayOrder);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.MoveMenuItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Section to put item in (will usually be original section)
menuSectionItemId int? ID of Item to be moved
destinationDisplayOrder int? New Display Order of item

Return type

void (empty response body)

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]

SetSectionItemTax

void SetSectionItemTax (int? menuId, int? menuSectionId, int? menuSectionItemId, int? taxRateId)

Set tax rate for menu item

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Section to put item in (will usually be original section)
            var menuSectionItemId = 56;  // int? | ID of Item to be moved
            var taxRateId = 56;  // int? | tax rate to be set against item

            try
            {
                // Set tax rate for menu item
                apiInstance.SetSectionItemTax(menuId, menuSectionId, menuSectionItemId, taxRateId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.SetSectionItemTax: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Section to put item in (will usually be original section)
menuSectionItemId int? ID of Item to be moved
taxRateId int? tax rate to be set against item

Return type

void (empty response body)

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]

UpdateMenuSectionItem

void UpdateMenuSectionItem (int? menuId, int? menuSectionId, int? menuSectionItemId, MenuSectionItemBase menuSectionItem, double? undoAfter = null)

Update menu section item

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var menuSectionItem = new MenuSectionItemBase(); // MenuSectionItemBase | Menu section item (delta)
            var undoAfter = 1.2;  // double? | An optional time period, in hours, after which the hide-section operation will be undone (optional) 

            try
            {
                // Update menu section item
                apiInstance.UpdateMenuSectionItem(menuId, menuSectionId, menuSectionItemId, menuSectionItem, undoAfter);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.UpdateMenuSectionItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
menuSectionItem MenuSectionItemBase Menu section item (delta)
undoAfter double? An optional time period, in hours, after which the hide-section operation will be undone [optional]

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]

UploadMenuSectionItemImage

RestApiStringResult UploadMenuSectionItemImage (int? menuId, int? menuSectionId, int? menuSectionItemId, System.IO.Stream image)

Upload menu section item image

Example

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

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

            var apiInstance = new MenuSectionItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var image = new System.IO.Stream(); // System.IO.Stream | Menu section item image

            try
            {
                // Upload menu section item image
                RestApiStringResult result = apiInstance.UploadMenuSectionItemImage(menuId, menuSectionId, menuSectionItemId, image);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionItemsApi.UploadMenuSectionItemImage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
image System.IO.Stream Menu section item image

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json, text/json, application/xml, text/xml

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