Skip to main content

AccountApiClient

Contains all the endpoints needed to manage categories.

Constructors

Constructor

new AccountApiClient(): AccountApiClient

Returns

AccountApiClient

Methods

create()

static create(data?, config?): Promise<SCUserType>

This endpoint create an account.

It requires an administration token.

Parameters

ParameterTypeDescription
data?AccountCreateParams
config?AxiosRequestConfig

Returns

Promise<SCUserType>


recover()

static recover(data?, config?): Promise<any>

This endpoint recover an account.

Parameters

ParameterTypeDescription
data?AccountRecoverParams
config?AxiosRequestConfig

Returns

Promise<any>


reset()

static reset(data?, config?): Promise<any>

This endpoint reset an account.

Parameters

ParameterTypeDescription
data?AccountResetParams
config?AxiosRequestConfig

Returns

Promise<any>


static search(params?, config?): Promise<SCUserType>

This endpoint search an account.

It requires an administration token.

Parameters

ParameterTypeDescription
params?AccountSearchParams
config?AxiosRequestConfig

Returns

Promise<SCUserType>


verify()

static verify(data?, config?): Promise<any>

This endpoint verify an account.

Parameters

ParameterTypeDescription
data?AccountVerifyParams
config?AxiosRequestConfig

Returns

Promise<any>


verifyValidationCode()

static verifyValidationCode(data?, config?): Promise<any>

This endpoint verify if a validation code is valid.

Parameters

ParameterTypeDescription
data?AccountVerifyParams
config?AxiosRequestConfig

Returns

Promise<any>