Class: AccountService
services/account.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
constructor
• new AccountService(): AccountService
Returns
Methods
create
▸ create(data?, config?): Promise<SCUserType>
Parameters
| Name | Type |
|---|---|
data? | AccountCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserType>
Defined in
recover
▸ recover(data?, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
data? | AccountRecoverParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
reset
▸ reset(data?, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
data? | AccountResetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
search
▸ search(params?, config?): Promise<SCUserType>
Parameters
| Name | Type |
|---|---|
params? | AccountSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserType>
Defined in
verify
▸ verify(data?, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
data? | AccountVerifyParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
verifyValidationCode
▸ verifyValidationCode(params?, config?): Promise<SCUserType>
Parameters
| Name | Type |
|---|---|
params? | AccountVerifyParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserType>