CustomAdvApiClient

Contains all the endpoints needed to manage custom advs.

Constructors

new CustomAdvApiClient()

new CustomAdvApiClient(): CustomAdvApiClient

Returns

CustomAdvApiClient

Methods

getASpecificCustomAdv()

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

This endpoint retrieves a specific custom adv.

Parameters

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

Returns

Promise<SCCustomAdvType>

Source

services/custom_adv/index.ts:23

---

getAllCustomAdv()

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

This endpoint retrieves all custom advs.

Parameters

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

Returns

Promise <SCPaginatedResponse<SCCustomAdvType>>

Source

services/custom_adv/index.ts:32

---

searchCustomAdv()

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

This endpoint performs search of a Custom Adv

Parameters

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

Returns

Promise <SCPaginatedResponse<SCCustomAdvType>>

Source

services/custom_adv/index.ts:42