CustomAdvApiClient

Contains all the endpoints needed to manage custom advs.

Constructors

Constructor

new CustomAdvApiClient(): CustomAdvApiClient

Returns

CustomAdvApiClient

Methods

getAllCustomAdv()

static getAllCustomAdv(params?, config?): Promise<SCPaginatedResponse<SCCustomAdvType>>

This endpoint retrieves all custom advs.

Parameters

Parameter	Type	Description
params?	CustomAdvParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCustomAdvType>>

---

getASpecificCustomAdv()

static getASpecificCustomAdv(id, config?): Promise<SCCustomAdvType>

This endpoint retrieves a specific custom adv.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCustomAdvType>

---

searchCustomAdv()

static searchCustomAdv(params?, config?): Promise<SCPaginatedResponse<SCCustomAdvType>>

This endpoint performs search of a Custom Adv

Parameters

Parameter	Type	Description
params?	CustomAdvParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCustomAdvType>>