@spreeloop/orange_money/dist/src/disbursements/routes/routes.js

A orange money api integration package

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Routes = void 0;
const constants_1 = require("../utils/constants");
const apiHost = 'https://omapi.ynote.africa';
const apiTokenHost = 'https://omapi-token.ynote.africa/oauth2/token';
/**
 * Orange Money API routes builder.
 * @class
 */
class Routes {
    /**
     * Constructs a new {CommonRoutes}.
     * @constructor
     * @param {RoutesParams} config - The required global route configuration.
     */
    /**
     * Returns the base route for the API.
     *  e.g: https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1
     * @return {string} The base route.
     */
    baseRoute() {
        return `${apiHost}/${constants_1.DisbursementXTargetEnvironmentType.prod}`;
    }
    /**
     * This route is used to create an access token which can then be used to authorize and authenticate towards the other end-points of the API.
     * e.g : https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1 page 2
     * @return {string}
     */
    createAccessToken() {
        return apiTokenHost;
    }
    /**
     * This route is used to transfer an amount from the owner’s account to a payee account (customer).
     * e.g : https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1 page 4
     * @return {string} - The transfer route.
     */
    transfer() {
        return `${this.baseRoute()}/refund`;
    }
    /**
     * This route is used to get the status of a transfer.
     *
     * @param {string} Id - The reference of the transfer.
     * e.g : https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1  page 9
     * @return {string} - The transfer status route.
     */
    transferStatus(Id) {
        return `${this.baseRoute()}/refund/status/${Id}`;
    }
}
exports.Routes = Routes;
//# sourceMappingURL=routes.js.map