Class: CustomAdvApiClient
services/custom_adv.CustomAdvApiClient
Contains all the endpoints needed to manage custom advs.
Constructors
constructor
• new CustomAdvApiClient(): CustomAdvApiClient
Returns
Methods
getASpecificCustomAdv
▸ getASpecificCustomAdv(id, config?): Promise<SCCustomAdvType>
This endpoint retrieves a specific custom adv.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCCustomAdvType>
Defined in
services/custom_adv/index.ts:23
getAllCustomAdv
▸ getAllCustomAdv(params?, config?): Promise<SCPaginatedResponse<SCCustomAdvType>>
This endpoint retrieves all custom advs.
Parameters
| Name | Type |
|---|---|
params? | CustomAdvParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomAdvType>>
Defined in
services/custom_adv/index.ts:32
searchCustomAdv
▸ searchCustomAdv(params?, config?): Promise<SCPaginatedResponse<SCCustomAdvType>>
This endpoint performs search of a Custom Adv
Parameters
| Name | Type |
|---|---|
params? | CustomAdvParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomAdvType>>