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
AccountService
Methods
create()
static
create(data?
,config?
):Promise
<SCUserType
>
Parameters
Parameter | Type |
---|---|
data? | AccountCreateParams |
config? | AxiosRequestConfig |
Returns
Promise
<SCUserType
>
recover()
static
recover(data?
,config?
):Promise
<any
>
Parameters
Parameter | Type |
---|---|
data? | AccountRecoverParams |
config? | AxiosRequestConfig |
Returns
Promise
<any
>
reset()
static
reset(data?
,config?
):Promise
<any
>
Parameters
Parameter | Type |
---|---|
data? | AccountResetParams |
config? | AxiosRequestConfig |
Returns
Promise
<any
>
search()
static
search(params?
,config?
):Promise
<SCUserType
>
Parameters
Parameter | Type |
---|---|
params? | AccountSearchParams |
config? | AxiosRequestConfig |
Returns
Promise
<SCUserType
>
verify()
static
verify(data?
,config?
):Promise
<any
>
Parameters
Parameter | Type |
---|---|
data? | AccountVerifyParams |
config? | AxiosRequestConfig |
Returns
Promise
<any
>
verifyValidationCode()
static
verifyValidationCode(params?
,config?
):Promise
<SCUserType
>
Parameters
Parameter | Type |
---|---|
params? | AccountVerifyParams |
config? | AxiosRequestConfig |
Returns
Promise
<SCUserType
>