CustomMenuApiClient

Contains all the endpoints needed to manage custom menus.

Constructors

new CustomMenuApiClient()

new CustomMenuApiClient(): CustomMenuApiClient

Returns

CustomMenuApiClient

Methods

getASpecificCustomMenu()

static getASpecificCustomMenu(id, config?): Promise<SCCustomMenuType>

This endpoint retrieves a specific custom menu.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCCustomMenuType>

Source

services/custom_menu/index.ts:24

---

getAllCustomMenus()

static getAllCustomMenus(params?, config?): Promise <SCPaginatedResponse<SCCustomMenuType>>

This endpoint retrieves all custom menus.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomMenuType>>

Source

services/custom_menu/index.ts:33

---

getBaseCustomMenu()

static getBaseCustomMenu(config?): Promise<SCCustomMenuType>

This endpoint retrieves the base custom menu.

Parameters

Parameter	Type	Description
config?	AxiosRequestConfig<any>

Returns

Promise<SCCustomMenuType>

Source

services/custom_menu/index.ts:42

---

searchCustomMenus()

static searchCustomMenus(params?, config?): Promise <SCPaginatedResponse<SCCustomMenuType>>

This endpoint performs search of a Custom Menu

Parameters

Parameter	Type	Description
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomMenuType>>

Source

services/custom_menu/index.ts:51