@selfcommunity/api-services/lib/cjs/services/locality/index.js

Client api for SelfCommunity.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LocalityApiClient = void 0;
const tslib_1 = require("tslib");
const Endpoints_1 = tslib_1.__importDefault(require("../../constants/Endpoints"));
const apiRequest_1 = require("../../utils/apiRequest");
const url_1 = require("../../utils/url");
/**
 * Contains all the endpoints needed to manage localities.
 */
class LocalityApiClient {
    /**
     * This endpoint retrieves the list of available localities.
     * @param params
     * @param config
     */
    static getLocalities(params, config) {
        const p = (0, url_1.urlParams)(params);
        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetLocalities.url({})}?${p.toString()}`, method: Endpoints_1.default.GetLocalities.method }));
    }
    /**
     * This endpoint searches localities
     * @param params
     * @param config
     */
    static searchLocalities(params, config) {
        const p = (0, url_1.urlParams)(params);
        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.ComposerLocalitySearch.url({})}?${p.toString()}`, method: Endpoints_1.default.ComposerLocalitySearch.method }));
    }
}
exports.LocalityApiClient = LocalityApiClient;
/**
 *
 :::tip Locality service can be used in the following way:

 ```jsx
 1. Import the service from our library:

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

 async getLocalities() {
        return await LocalityService.getLocalities();
      }
 ```
 ```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 LocalityService {
    static getLocalities(params, config) {
        return tslib_1.__awaiter(this, void 0, void 0, function* () {
            return LocalityApiClient.getLocalities(params, config);
        });
    }
    static searchLocalities(params, config) {
        return tslib_1.__awaiter(this, void 0, void 0, function* () {
            return LocalityApiClient.searchLocalities(params, config);
        });
    }
}
exports.default = LocalityService;