Skip to main content

OnBoardingApiClientInterface

Methods

completeAStep()

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

Parameters

ParameterType
stepOnBoardingStep
config?AxiosRequestConfig

Returns

Promise<any>


getAllSteps()

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

Parameters

ParameterType
params?BaseSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCStepType>>


getAStep()

getAStep(step, config?): Promise<any>

Parameters

ParameterType
stepOnBoardingStep
config?AxiosRequestConfig

Returns

Promise<any>


startAStep()

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

Parameters

ParameterType
stepOnBoardingStep
params?StartStepParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCStepType>>