@selfcommunity/api-services
Version:
Client api for SelfCommunity.
66 lines (59 loc) • 1.97 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ContactUsApiClient = void 0;
const tslib_1 = require("tslib");
const Endpoints_1 = tslib_1.__importDefault(require("../../constants/Endpoints"));
const apiRequest_1 = require("../../utils/apiRequest");
/**
* Contains all the endpoints needed to contact-us.
*/
class ContactUsApiClient {
/**
* This endpoint create an contact request.
*
* It requires an authenticated user.
*
* @param data
* @param config
*/
static request(data, config) {
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { data, url: Endpoints_1.default.ContactRequest.url({}), method: Endpoints_1.default.ContactRequest.method }));
}
}
exports.ContactUsApiClient = ContactUsApiClient;
/**
*
:::tip Contact service can be used in the following way:
```jsx
1. Import the service from our library:
import {ContactService} from "@selfcommunity/api-services";
```
```jsx
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 ContactService.request();
}
```
```jsx
In case of required `params`, just add them inside the brackets.
async request(data) {
return await ContactService.request(data);
}
```
```jsx
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!
```
:::
*/
class ContactUsService {
static request(data, config) {
return tslib_1.__awaiter(this, void 0, void 0, function* () {
return ContactUsApiClient.request(data, config);
});
}
}
exports.default = ContactUsService;