OnBoardingService

OnBoarding service can be used in the following way:

1. Import the service from our library:

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

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

async getAStep() {
  return await OnBoardingService.getAStep();
}

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

async create(data) {
 return await OnBoardingService.getAStep(step);
}

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 OnBoardingService()

new OnBoardingService(): OnBoardingService

Returns

OnBoardingService

Methods

completeAStep()

static completeAStep(step, config?): Promise<any>

Parameters

Parameter	Type
step	OnBoardingStep
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/onboarding/index.ts:101

---

getAStep()

static getAStep(step, config?): Promise<SCStepType>

Parameters

Parameter	Type
step	OnBoardingStep
config?	AxiosRequestConfig<any>

Returns

Promise<SCStepType>

Source

services/onboarding/index.ts:93

---

getAllSteps()

static getAllSteps(params?, config?): Promise <SCPaginatedResponse<SCStepType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCStepType>>

Source

services/onboarding/index.ts:89

---

startAStep()

static startAStep(step, params?, config?): Promise <SCPaginatedResponse<SCStepType>>

Parameters

Parameter	Type
step	OnBoardingStep
params?	StartStepParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCStepType>>

Source

services/onboarding/index.ts:97