Skip to main content

AccountService

Account service can be used in the following way:
1. Import the service from our library:

import {AccountService} from "@selfcommunity/api-services";
2. Create a function and put the service inside it!
The async function `create` will return the paginated list of categories.

async create() {
return await AccountService.create();
}
In case of required `params`, just add them inside the brackets.

async create(data) {
return await AccountService.create(data);
}
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

new AccountService()

new AccountService(): AccountService

Returns

AccountService

Methods

create()

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

Parameters

ParameterType
data?AccountCreateParams
config?AxiosRequestConfig<any>

Returns

Promise<SCUserType>

Source

services/account/index.ts:110


recover()

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

Parameters

ParameterType
data?AccountRecoverParams
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:119


reset()

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

Parameters

ParameterType
data?AccountResetParams
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:122


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

Parameters

ParameterType
params?AccountSearchParams
config?AxiosRequestConfig<any>

Returns

Promise<SCUserType>

Source

services/account/index.ts:125


verify()

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

Parameters

ParameterType
data?AccountVerifyParams
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/account/index.ts:113


verifyValidationCode()

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

Parameters

ParameterType
params?AccountVerifyParams
config?AxiosRequestConfig<any>

Returns

Promise<SCUserType>

Source

services/account/index.ts:116