AccountApiClient

Contains all the endpoints needed to manage categories.

Constructors

new AccountApiClient()

new AccountApiClient(): AccountApiClient

Returns

AccountApiClient

Methods

create()

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

This endpoint create an account.

It requires an administration token.

Parameters

Parameter	Type	Description
data?	AccountCreateParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserType>

Source

services/account/index.ts:27

---

recover()

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

This endpoint recover an account.

Parameters

Parameter	Type	Description
data?	AccountRecoverParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:51

---

reset()

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

This endpoint reset an account.

Parameters

Parameter	Type	Description
data?	AccountResetParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:59

---

search()

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

This endpoint search an account.

It requires an administration token.

Parameters

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

Returns

Promise<SCUserType>

Source

services/account/index.ts:70

---

verify()

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

This endpoint verify an account.

Parameters

Parameter	Type	Description
data?	AccountVerifyParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:35

---

verifyValidationCode()

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

This endpoint verify if a validation code is valid.

Parameters

Parameter	Type	Description
data?	AccountVerifyParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:43