CustomPageApiClient

Contains all the endpoints needed to manage custom pages.

Constructors

new CustomPageApiClient()

new CustomPageApiClient(): CustomPageApiClient

Returns

CustomPageApiClient

Methods

getASpecificCustomPage()

static getASpecificCustomPage(id, config?): Promise<SCCustomPageType>

This endpoint retrieves a specific custom page.

Parameters

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

Returns

Promise<SCCustomPageType>

Source

services/custom_page/index.ts:23

---

getAllCustomPages()

static getAllCustomPages(params?, config?): Promise <SCPaginatedResponse<SCCustomPageType>>

This endpoint retrieves all custom pages.

Parameters

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

Returns

Promise <SCPaginatedResponse<SCCustomPageType>>

Source

services/custom_page/index.ts:32

---

searchCustomPages()

static searchCustomPages(params?, config?): Promise <SCPaginatedResponse<SCCustomPageType>>

This endpoint performs search of a Custom Page

Parameters

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

Returns

Promise <SCPaginatedResponse<SCCustomPageType>>

Source

services/custom_page/index.ts:42