Skip to content

Latest commit

 

History

History
578 lines (454 loc) · 21.6 KB

MenuOptionSetItemsApi.md

File metadata and controls

578 lines (454 loc) · 21.6 KB

Flipdish.Api.MenuOptionSetItemsApi

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

Method HTTP request Description
AddMenuItemOptionSetItem POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems Create menu item option set item
DeleteOptionSetItemImage DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/image Delete menu item option set item image
GetMenuItemOptionSetItemById GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId} Get menu item option set item by identifier
GetMenuItemOptionSetItems GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems Get menu item option set items
RemoveMenuItemOptionSetItem DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId} Delete menu item option set item
SetOptionSetItemTax POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/taxrate/{taxRateId} Set Tax Rate on OptionSetItem
UpdateMenuItemOptionSetItem POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId} Update menu item option set item
UploadOptionSetItemImage POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/image Upload menu item option set item image

AddMenuItemOptionSetItem

Object AddMenuItemOptionSetItem (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, MenuItemOptionSetItemBase menuItemOptionSetItem)

Create menu item option set item

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var optionSetId = 56;  // int? | Option set identifier
            var menuItemOptionSetItem = new MenuItemOptionSetItemBase(); // MenuItemOptionSetItemBase | Option set item

            try
            {
                // Create menu item option set item
                Object result = apiInstance.AddMenuItemOptionSetItem(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.AddMenuItemOptionSetItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
optionSetId int? Option set identifier
menuItemOptionSetItem MenuItemOptionSetItemBase Option set 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]

DeleteOptionSetItemImage

void DeleteOptionSetItemImage (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, int? menuItemOptionSetItemId)

Delete menu item option set item image

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var optionSetId = 56;  // int? | Option set identifier
            var menuItemOptionSetItemId = 56;  // int? | Option set item identifier

            try
            {
                // Delete menu item option set item image
                apiInstance.DeleteOptionSetItemImage(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.DeleteOptionSetItemImage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
optionSetId int? Option set identifier
menuItemOptionSetItemId int? Option set 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]

GetMenuItemOptionSetItemById

RestApiResultMenuItemOptionSetItem GetMenuItemOptionSetItemById (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, int? menuItemOptionSetItemId)

Get menu item option set item by identifier

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var optionSetId = 56;  // int? | Option set identifier
            var menuItemOptionSetItemId = 56;  // int? | Option set item identifier

            try
            {
                // Get menu item option set item by identifier
                RestApiResultMenuItemOptionSetItem result = apiInstance.GetMenuItemOptionSetItemById(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.GetMenuItemOptionSetItemById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
optionSetId int? Option set identifier
menuItemOptionSetItemId int? Option set item identifier

Return type

RestApiResultMenuItemOptionSetItem

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]

GetMenuItemOptionSetItems

RestApiArrayResultMenuItemOptionSetItem GetMenuItemOptionSetItems (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId)

Get menu item option set items

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var optionSetId = 56;  // int? | Option set identifier

            try
            {
                // Get menu item option set items
                RestApiArrayResultMenuItemOptionSetItem result = apiInstance.GetMenuItemOptionSetItems(menuId, menuSectionId, menuSectionItemId, optionSetId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.GetMenuItemOptionSetItems: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

RestApiArrayResultMenuItemOptionSetItem

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]

RemoveMenuItemOptionSetItem

void RemoveMenuItemOptionSetItem (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, int? menuItemOptionSetItemId)

Delete menu item option set item

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var optionSetId = 56;  // int? | Option set identifier
            var menuItemOptionSetItemId = 56;  // int? | Option set item identifier

            try
            {
                // Delete menu item option set item
                apiInstance.RemoveMenuItemOptionSetItem(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.RemoveMenuItemOptionSetItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
optionSetId int? Option set identifier
menuItemOptionSetItemId int? Option set 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]

SetOptionSetItemTax

void SetOptionSetItemTax (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, int? menuItemOptionSetItemId, int? taxRateId)

Set Tax Rate on OptionSetItem

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | 
            var menuSectionItemId = 56;  // int? | 
            var optionSetId = 56;  // int? | 
            var menuItemOptionSetItemId = 56;  // int? | Option set item identifier
            var taxRateId = 56;  // int? | Tax Rate to use

            try
            {
                // Set Tax Rate on OptionSetItem
                apiInstance.SetOptionSetItemTax(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItemId, taxRateId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.SetOptionSetItemTax: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int?
menuSectionItemId int?
optionSetId int?
menuItemOptionSetItemId int? Option set item identifier
taxRateId int? Tax Rate to use

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]

UpdateMenuItemOptionSetItem

void UpdateMenuItemOptionSetItem (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, int? menuItemOptionSetItemId, MenuItemOptionSetItemBase menuItemOptionSetItem, double? undoAfter = null)

Update menu item option set item

Example

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

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

            var apiInstance = new MenuOptionSetItemsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionItemId = 56;  // int? | Menu section item identifier
            var optionSetId = 56;  // int? | Option set identifier
            var menuItemOptionSetItemId = 56;  // int? | Option set item identifier
            var menuItemOptionSetItem = new MenuItemOptionSetItemBase(); // MenuItemOptionSetItemBase | Option set 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 item option set item
                apiInstance.UpdateMenuItemOptionSetItem(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItemId, menuItemOptionSetItem, undoAfter);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.UpdateMenuItemOptionSetItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
optionSetId int? Option set identifier
menuItemOptionSetItemId int? Option set item identifier
menuItemOptionSetItem MenuItemOptionSetItemBase Option set 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]

UploadOptionSetItemImage

RestApiStringResult UploadOptionSetItemImage (int? menuId, int? menuSectionId, int? menuSectionItemId, int? optionSetId, int? menuItemOptionSetItemId, System.IO.Stream image)

Upload menu item option set item image

Example

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

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

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

            try
            {
                // Upload menu item option set item image
                RestApiStringResult result = apiInstance.UploadOptionSetItemImage(menuId, menuSectionId, menuSectionItemId, optionSetId, menuItemOptionSetItemId, image);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuOptionSetItemsApi.UploadOptionSetItemImage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionItemId int? Menu section item identifier
optionSetId int? Option set identifier
menuItemOptionSetItemId int? Option set item identifier
image System.IO.Stream Option set 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]