Class: CustomMenuApiClient
services/custom_menu.CustomMenuApiClient
Contains all the endpoints needed to manage custom menus.
Constructors
constructor
• new CustomMenuApiClient(): CustomMenuApiClient
Returns
Methods
getASpecificCustomMenu
▸ getASpecificCustomMenu(id, config?): Promise<SCCustomMenuType>
This endpoint retrieves a specific custom menu.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCCustomMenuType>
Defined in
services/custom_menu/index.ts:24
getAllCustomMenus
▸ getAllCustomMenus(params?, config?): Promise<SCPaginatedResponse<SCCustomMenuType>>
This endpoint retrieves all custom menus.
Parameters
| Name | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomMenuType>>
Defined in
services/custom_menu/index.ts:33
getBaseCustomMenu
▸ getBaseCustomMenu(config?): Promise<SCCustomMenuType>
This endpoint retrieves the base custom menu.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCCustomMenuType>
Defined in
services/custom_menu/index.ts:42
searchCustomMenus
▸ searchCustomMenus(params?, config?): Promise<SCPaginatedResponse<SCCustomMenuType>>
This endpoint performs search of a Custom Menu
Parameters
| Name | Type |
|---|---|
params? | BaseSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomMenuType>>