OnBoardingApiClient
Contains all the endpoints needed to manage OnBoarding content.
Constructors
Constructor
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 |
Returns
Promise
<any
>
getAllSteps()
static
getAllSteps(params?
,config?
):Promise
<SCPaginatedResponse
<SCStepType
>>
This endpoint retrieves all onboarding steps.
Parameters
Parameter | Type | Description |
---|---|---|
params? | BaseSearchParams | |
config? | AxiosRequestConfig |
Returns
Promise
<SCPaginatedResponse
<SCStepType
>>
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 |
Returns
Promise
<SCStepType
>
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 |
Returns
Promise
<SCPaginatedResponse
<SCStepType
>>