CustomMenuApiClient

Contains all the endpoints needed to manage custom menus.

Constructors

Constructor

new CustomMenuApiClient(): CustomMenuApiClient

Returns

CustomMenuApiClient

Methods

getAllCustomMenus()

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

This endpoint retrieves all custom menus.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCustomMenuType>>

---

getASpecificCustomMenu()

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

This endpoint retrieves a specific custom menu.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCustomMenuType>

---

getBaseCustomMenu()

static getBaseCustomMenu(config?): Promise<SCCustomMenuType>

This endpoint retrieves the base custom menu.

Parameters

Parameter	Type	Description
config?	AxiosRequestConfig

Returns

Promise<SCCustomMenuType>

---

searchCustomMenus()

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

This endpoint performs search of a Custom Menu

Parameters

Parameter	Type	Description
params?	BaseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCustomMenuType>>