Flipdish\Client\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

\Flipdish\Client\Models\RestApiResultMenuSection cloneMenuSection($menu_id, $menu_section_id)

Clone menu section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier

try {
    $result = $apiInstance->cloneMenuSection($menu_id, $menu_section_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->cloneMenuSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier

Return type

\Flipdish\Client\Models\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($menu_id, $menu_section_id, $day_of_week, $business_hours_period)

Set/update menu section availability hours.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$day_of_week = "day_of_week_example"; // string | Day of the  week
$business_hours_period = new \Flipdish\\Client\Models\BusinessHoursPeriodBase(); // \Flipdish\\Client\Models\BusinessHoursPeriodBase | Menu section active hours, note: DayOfWeek property will be overriden by the path parameter.

try {
    $result = $apiInstance->createMenuAvailabilityForDay($menu_id, $menu_section_id, $day_of_week, $business_hours_period);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->createMenuAvailabilityForDay: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
day_of_week	string	Day of the week
business_hours_period	\Flipdish\Client\Models\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($menu_id, $menu_section)

Create menu section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section = new \Flipdish\\Client\Models\MenuSectionBase(); // \Flipdish\\Client\Models\MenuSectionBase | Menu section

try {
    $result = $apiInstance->createMenuSection($menu_id, $menu_section);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->createMenuSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section	\Flipdish\Client\Models\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($menu_id, $menu_section_id, $menu_section_availability)

Create menu availability type

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section_availability = new \Flipdish\\Client\Models\MenuSectionAvailabilityBase(); // \Flipdish\\Client\Models\MenuSectionAvailabilityBase | DisplayAlways, DisplayBasedOnTimes, DisplayAlwaysStartCollapsed, DisplayAlwaysStartCollapsedBasedOnTimes

try {
    $result = $apiInstance->createMenuSectionAvailability($menu_id, $menu_section_id, $menu_section_availability);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->createMenuSectionAvailability: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section_availability	\Flipdish\Client\Models\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

deleteMenuSection($menu_id, $menu_section_id)

Delete menu section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier

try {
    $apiInstance->deleteMenuSection($menu_id, $menu_section_id);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->deleteMenuSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	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

deleteMenuSectionImage($menu_id, $menu_section_id)

Delete menu section image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier

try {
    $apiInstance->deleteMenuSectionImage($menu_id, $menu_section_id);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->deleteMenuSectionImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	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

\Flipdish\Client\Models\RestApiResultMenuSection getMenuSectionById($menu_id, $menu_section_id)

Get menu section by identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier

try {
    $result = $apiInstance->getMenuSectionById($menu_id, $menu_section_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->getMenuSectionById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiArrayResultMenuSection getMenuSections($menu_id)

Get menu sections

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier

try {
    $result = $apiInstance->getMenuSections($menu_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->getMenuSections: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier

Return type

\Flipdish\Client\Models\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

menuSectionsSetItemDisplayOrders($menu_id, $menu_section_id, $display_orders)

Re-arrange Items within a Section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$display_orders = new \Flipdish\\Client\Models\MenuObjectDisplayOrders(); // \Flipdish\\Client\Models\MenuObjectDisplayOrders | Item Ids and their new display order

try {
    $apiInstance->menuSectionsSetItemDisplayOrders($menu_id, $menu_section_id, $display_orders);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->menuSectionsSetItemDisplayOrders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
display_orders	\Flipdish\Client\Models\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

updateMenuSection($menu_id, $menu_section_id, $menu_section, $undo_after)

Update menu section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$menu_section = new \Flipdish\\Client\Models\MenuSectionBase(); // \Flipdish\\Client\Models\MenuSectionBase | Menu section changes (delta)
$undo_after = 1.2; // double | An optional time period, in hours, after which the hide-section operation will be undone.

try {
    $apiInstance->updateMenuSection($menu_id, $menu_section_id, $menu_section, $undo_after);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->updateMenuSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
menu_section	\Flipdish\Client\Models\MenuSectionBase	Menu section changes (delta)
undo_after	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

\Flipdish\Client\Models\RestApiStringResult uploadMenuSectionImage($menu_id, $menu_section_id, $image)

Upload menu section image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MenuSectionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$menu_id = 56; // int | Menu identifier
$menu_section_id = 56; // int | Menu section identifier
$image = "/path/to/file.txt"; // \SplFileObject | Menu section image

try {
    $result = $apiInstance->uploadMenuSectionImage($menu_id, $menu_section_id, $image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MenuSectionsApi->uploadMenuSectionImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
menu_id	int	Menu identifier
menu_section_id	int	Menu section identifier
image	\SplFileObject	Menu section image

Return type

\Flipdish\Client\Models\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]

FilesExpand file tree

MenuSectionsApi.md

Latest commit

History

MenuSectionsApi.md

File metadata and controls

Flipdish\Client\MenuSectionsApi

cloneMenuSection

Example

Parameters

Return type

Authorization

HTTP request headers

createMenuAvailabilityForDay

Example

Parameters

Return type

Authorization

HTTP request headers

createMenuSection

Example

Parameters

Return type

Authorization

HTTP request headers

createMenuSectionAvailability

Example

Parameters

Return type

Authorization

HTTP request headers

deleteMenuSection

Example

Parameters

Return type

Authorization

HTTP request headers

deleteMenuSectionImage

Example

Parameters

Return type

Authorization

HTTP request headers

getMenuSectionById

Example

Parameters

Return type

Authorization

HTTP request headers

getMenuSections

Example

Parameters

Return type

Authorization

HTTP request headers

menuSectionsSetItemDisplayOrders

Example

Parameters

Return type

Authorization

HTTP request headers

updateMenuSection

Example

Parameters

Return type

Authorization

HTTP request headers

uploadMenuSectionImage

Example

Parameters

Return type

Authorization

HTTP request headers