CustomAdvService

Custom Adv service can be used in the following way:

1. Import the service from our library:

import {CustomAdvService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllCustomAdv` will return the paginated list of advs.

async getAllCustomAdv() {
       return await CustomAdvService.getAllCustomAdv();
     }

In case of required `params`, just add them inside the brackets.

async getASpecificCustomAdv(customAdvId) {
       return await CustomAdvService.getASpecificCustomAdv(customAdvId);
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

new CustomAdvService()

new CustomAdvService(): CustomAdvService

Returns

CustomAdvService

Methods

getASpecificCustomAdv()

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

Parameters

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

Returns

Promise<SCCustomAdvType>

Source

services/custom_adv/index.ts:84

---

getAllCustomAdv()

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

Parameters

Parameter	Type
params?	CustomAdvParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomAdvType>>

Source

services/custom_adv/index.ts:87

---

searchCustomAdv()

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

Parameters

Parameter	Type
params?	CustomAdvParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomAdvType>>

Source

services/custom_adv/index.ts:90