OnBoardingApiClient

Contains all the endpoints needed to manage OnBoarding content.

Constructors

new OnBoardingApiClient()

new OnBoardingApiClient(): OnBoardingApiClient

Returns

OnBoardingApiClient

Methods

completeAStep()

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

This endpoint marks a step complete.

Parameters

Parameter	Type	Description
step	OnBoardingStep
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/onboarding/index.ts:49

---

getAStep()

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

This endpoint retrieves a specific step identified by the step id.

Parameters

Parameter	Type	Description
step	OnBoardingStep
config?	AxiosRequestConfig<any>

Returns

Promise<SCStepType>

Source

services/onboarding/index.ts:32

---

getAllSteps()

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

This endpoint retrieves all onboarding steps.

Parameters

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

Returns

Promise <SCPaginatedResponse<SCStepType>>

Source

services/onboarding/index.ts:24

---

startAStep()

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

This endpoint performs step content generation.

Parameters

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

Returns

Promise <SCPaginatedResponse<SCStepType>>

Source

services/onboarding/index.ts:41