Class: AccountApiClient
services/account.AccountApiClient
Contains all the endpoints needed to manage categories.
Constructors
constructor
• new AccountApiClient(): AccountApiClient
Returns
Methods
create
▸ create(data?, config?): Promise<SCUserType>
This endpoint create an account.
It requires an administration token.
Parameters
| Name | Type |
|---|---|
data? | AccountCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserType>
Defined in
recover
▸ recover(data?, config?): Promise<any>
This endpoint recover an account.
Parameters
| Name | Type |
|---|---|
data? | AccountRecoverParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
reset
▸ reset(data?, config?): Promise<any>
This endpoint reset an account.
Parameters
| Name | Type |
|---|---|
data? | AccountResetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
search
▸ search(params?, config?): Promise<SCUserType>
This endpoint search an account.
It requires an administration token.
Parameters
| Name | Type |
|---|---|
params? | AccountSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserType>
Defined in
verify
▸ verify(data?, config?): Promise<any>
This endpoint verify an account.
Parameters
| Name | Type |
|---|---|
data? | AccountVerifyParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
verifyValidationCode
▸ verifyValidationCode(data?, config?): Promise<any>
This endpoint verify if a validation code is valid.
Parameters
| Name | Type |
|---|---|
data? | AccountVerifyParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>