Class: CustomPageApiClient
services/custom_page.CustomPageApiClient
Contains all the endpoints needed to manage custom pages.
Constructors
constructor
• new CustomPageApiClient(): CustomPageApiClient
Returns
Methods
getASpecificCustomPage
▸ getASpecificCustomPage(id, config?): Promise<SCCustomPageType>
This endpoint retrieves a specific custom page.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCCustomPageType>
Defined in
services/custom_page/index.ts:23
getAllCustomPages
▸ getAllCustomPages(params?, config?): Promise<SCPaginatedResponse<SCCustomPageType>>
This endpoint retrieves all custom pages.
Parameters
| Name | Type |
|---|---|
params? | CustomPageParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomPageType>>
Defined in
services/custom_page/index.ts:32
searchCustomPages
▸ searchCustomPages(params?, config?): Promise<SCPaginatedResponse<SCCustomPageType>>
This endpoint performs search of a Custom Page
Parameters
| Name | Type |
|---|---|
params? | CustomPageSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomPageType>>