Skip to content

Latest commit

 

History

History
731 lines (562 loc) · 23.1 KB

MenuSectionsApi.md

File metadata and controls

731 lines (562 loc) · 23.1 KB

Flipdish.Api.MenuSectionsApi

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

Method HTTP request Description
CloneMenuSection POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/clone Clone menu section
CreateMenuAvailabilityForDay POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/availability/times/{dayOfWeek} Set/update menu section availability hours.
CreateMenuSection POST /api/v1.0/menus/{menuId}/sections Create menu section
CreateMenuSectionAvailability POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/availability Create menu availability type
DeleteMenuSection DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId} Delete menu section
DeleteMenuSectionImage DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/image Delete menu section image
GetMenuSectionById GET /api/v1.0/menus/{menuId}/sections/{menuSectionId} Get menu section by identifier
GetMenuSections GET /api/v1.0/menus/{menuId}/sections Get menu sections
MenuSectionsSetItemDisplayOrders POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitemdisplayorders Re-arrange Items within a Section
UpdateMenuSection POST /api/v1.0/menus/{menuId}/sections/{menuSectionId} Update menu section
UploadMenuSectionImage POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/image Upload menu section image

CloneMenuSection

RestApiResultMenuSection CloneMenuSection (int? menuId, int? menuSectionId)

Clone menu section

Example

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

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

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

            try
            {
                // Clone menu section
                RestApiResultMenuSection result = apiInstance.CloneMenuSection(menuId, menuSectionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.CloneMenuSection: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

RestApiResultMenuSection

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]

CreateMenuAvailabilityForDay

Object CreateMenuAvailabilityForDay (int? menuId, int? menuSectionId, string dayOfWeek, BusinessHoursPeriodBase businessHoursPeriod)

Set/update menu section availability hours.

Example

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

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

            var apiInstance = new MenuSectionsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var dayOfWeek = dayOfWeek_example;  // string | Day of the  week
            var businessHoursPeriod = new BusinessHoursPeriodBase(); // BusinessHoursPeriodBase | Menu section active hours, note: DayOfWeek property will be overriden by the path parameter.

            try
            {
                // Set/update menu section availability hours.
                Object result = apiInstance.CreateMenuAvailabilityForDay(menuId, menuSectionId, dayOfWeek, businessHoursPeriod);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.CreateMenuAvailabilityForDay: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
dayOfWeek string Day of the week
businessHoursPeriod BusinessHoursPeriodBase Menu section active hours, note: DayOfWeek property will be overriden by the path parameter.

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]

CreateMenuSection

Object CreateMenuSection (int? menuId, MenuSectionBase menuSection)

Create menu section

Example

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

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

            var apiInstance = new MenuSectionsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSection = new MenuSectionBase(); // MenuSectionBase | Menu section

            try
            {
                // Create menu section
                Object result = apiInstance.CreateMenuSection(menuId, menuSection);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.CreateMenuSection: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSection MenuSectionBase Menu section

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]

CreateMenuSectionAvailability

Object CreateMenuSectionAvailability (int? menuId, int? menuSectionId, MenuSectionAvailabilityBase menuSectionAvailability)

Create menu availability type

Example

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

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

            var apiInstance = new MenuSectionsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSectionAvailability = new MenuSectionAvailabilityBase(); // MenuSectionAvailabilityBase | DisplayAlways, DisplayBasedOnTimes, DisplayAlwaysStartCollapsed, DisplayAlwaysStartCollapsedBasedOnTimes

            try
            {
                // Create menu availability type
                Object result = apiInstance.CreateMenuSectionAvailability(menuId, menuSectionId, menuSectionAvailability);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.CreateMenuSectionAvailability: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSectionAvailability MenuSectionAvailabilityBase DisplayAlways, DisplayBasedOnTimes, DisplayAlwaysStartCollapsed, DisplayAlwaysStartCollapsedBasedOnTimes

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]

DeleteMenuSection

void DeleteMenuSection (int? menuId, int? menuSectionId)

Delete menu section

Example

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

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

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

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

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section 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]

DeleteMenuSectionImage

void DeleteMenuSectionImage (int? menuId, int? menuSectionId)

Delete menu section image

Example

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

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

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

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

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section 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]

GetMenuSectionById

RestApiResultMenuSection GetMenuSectionById (int? menuId, int? menuSectionId)

Get menu section by identifier

Example

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

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

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

            try
            {
                // Get menu section by identifier
                RestApiResultMenuSection result = apiInstance.GetMenuSectionById(menuId, menuSectionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.GetMenuSectionById: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

RestApiResultMenuSection

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]

GetMenuSections

RestApiArrayResultMenuSection GetMenuSections (int? menuId)

Get menu sections

Example

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

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

            var apiInstance = new MenuSectionsApi();
            var menuId = 56;  // int? | Menu identifier

            try
            {
                // Get menu sections
                RestApiArrayResultMenuSection result = apiInstance.GetMenuSections(menuId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.GetMenuSections: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier

Return type

RestApiArrayResultMenuSection

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]

MenuSectionsSetItemDisplayOrders

void MenuSectionsSetItemDisplayOrders (int? menuId, int? menuSectionId, MenuObjectDisplayOrders displayOrders)

Re-arrange Items within a Section

Example

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

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

            var apiInstance = new MenuSectionsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var displayOrders = new MenuObjectDisplayOrders(); // MenuObjectDisplayOrders | Item Ids and their new display order

            try
            {
                // Re-arrange Items within a Section
                apiInstance.MenuSectionsSetItemDisplayOrders(menuId, menuSectionId, displayOrders);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.MenuSectionsSetItemDisplayOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
displayOrders MenuObjectDisplayOrders Item Ids and their new display order

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]

UpdateMenuSection

void UpdateMenuSection (int? menuId, int? menuSectionId, MenuSectionBase menuSection, double? undoAfter = null)

Update menu section

Example

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

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

            var apiInstance = new MenuSectionsApi();
            var menuId = 56;  // int? | Menu identifier
            var menuSectionId = 56;  // int? | Menu section identifier
            var menuSection = new MenuSectionBase(); // MenuSectionBase | Menu section changes (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
                apiInstance.UpdateMenuSection(menuId, menuSectionId, menuSection, undoAfter);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MenuSectionsApi.UpdateMenuSection: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
menuId int? Menu identifier
menuSectionId int? Menu section identifier
menuSection MenuSectionBase Menu section changes (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]

UploadMenuSectionImage

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

Upload menu section image

Example

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

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

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

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

Parameters

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