CustomPageApiClient
Contains all the endpoints needed to manage custom pages.
Constructors
Constructor
new CustomPageApiClient():
CustomPageApiClient
Returns
CustomPageApiClient
Methods
getAllCustomPages()
static
getAllCustomPages(params?
,config?
):Promise
<SCPaginatedResponse
<SCCustomPageType
>>
This endpoint retrieves all custom pages.
Parameters
Parameter | Type | Description |
---|---|---|
params? | CustomPageParams | |
config? | AxiosRequestConfig |
Returns
Promise
<SCPaginatedResponse
<SCCustomPageType
>>
getASpecificCustomPage()
static
getASpecificCustomPage(id
,config?
):Promise
<SCCustomPageType
>
This endpoint retrieves a specific custom page.
Parameters
Parameter | Type | Description |
---|---|---|
id | string | number | |
config? | AxiosRequestConfig |
Returns
Promise
<SCCustomPageType
>
searchCustomPages()
static
searchCustomPages(params?
,config?
):Promise
<SCPaginatedResponse
<SCCustomPageType
>>
This endpoint performs search of a Custom Page
Parameters
Parameter | Type | Description |
---|---|---|
params? | CustomPageSearchParams | |
config? | AxiosRequestConfig |
Returns
Promise
<SCPaginatedResponse
<SCCustomPageType
>>