Skip to main content

OnBoardingApiClientInterface

Methods

completeAStep()

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

Parameters

ParameterType
stepOnBoardingStep
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/onboarding/index.ts:12


getAStep()

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

Parameters

ParameterType
stepOnBoardingStep
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/onboarding/index.ts:10


getAllSteps()

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

Parameters

ParameterType
params?BaseSearchParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCStepType>>

Source

services/onboarding/index.ts:9


startAStep()

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

Parameters

ParameterType
stepOnBoardingStep
params?StartStepParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCStepType>>

Source

services/onboarding/index.ts:11