@spreeloop/orange_money 1.0.7 → 1.0.8

package/dist/orange_money/src/payments/utils/constants.d.ts

@@ -0,0 +1,96 @@
+export declare enum ApiKey {
+    keyAuthorization = "Authorization",
+    keyGrantType = "grant_type",
+    keyContentType = "Content-Type",
+    keyXAuthToken = "X-AUTH-TOKEN",
+    keyMerchantKey = "merchant_key",
+    keyCurrency = "currency",
+    keyOrderId = "order_id",
+    keyReturnUrl = "return_url",
+    keyCancelUrl = "cancel_url",
+    keyWebNotifyUrl = "notif_url",
+    keyLang = "lang",
+    keyReference = "reference",
+    keyAmount = "amount",
+    keyPayToken = "pay_token",
+    keySubscriberMsisdn = "subscriberMsisdn",
+    keyChannelUserMsisdn = "channelUserMsisdn",
+    keyDescription = "description",
+    keyMobileOrderId = "orderId",
+    keyPin = "pin",
+    keyMobilePayToken = "payToken",
+    keyMobileNotifUrl = "notifUrl"
+}
+/**
+ * Contains request fields.
+ */
+export declare class ConstantRequestField {
+    static readonly typeJson = "application/json";
+    static readonly TypeWwwFrom = "application/x-www-form-urlencoded";
+    static readonly basic = "Basic ";
+    static readonly authorization = "AUTHORIZATION";
+    static readonly bearer = "Bearer ";
+    static readonly grantType = "grant_type";
+    static readonly clientCredentials = "client_credentials";
+    static readonly xAuthToken = "X-AUTH-TOKEN";
+}
+/**
+ * The orange money payment status.
+ */
+export declare enum OrangeMoneyPaymentStatus {
+    /**
+     * User has clicked on “Confirmed”, transaction
+     * is in progress on Orange system.
+     */
+    PENDING_PAYMENT = "PENDING",
+    /**
+     * The user canceled the payment.
+     */
+    CANCELLED_PAYMENT = "CANCELLED",
+    /**
+     * Waiting for user entry.
+     * Specially for web.
+     */
+    INITIATE_PAYMENT = "INITIATED",
+    /**
+     * Payment is done for mobile.
+     */
+    SUCCESSFULL_MOBILE_PAYMENT = "SUCCESSFULL",
+    /**
+     * Payment is done for web.
+     */
+    SUCCESS_WEB_PAYMENT = "SUCCESS",
+    /**
+     * Payment has failed.
+     * On web, the status can failed when user press to confirm payment too
+     * late or when user enter a wrong validation code.
+     * On mobile, it may fail when the user does not have a mooney orange wallet
+     * or the account balance is insufficient.
+     */
+    FAILED_PAYMENT = "FAILED",
+    /**
+     * User has clicked on “Confirmed” too late (after token’s validity), or the
+     * delay token timeout has expired.
+     * Note that the minimum token expiration time is 7 min.
+     */
+    EXPIRED_PAYMENT = "EXPIRED"
+}
+export declare enum ApiErrorType {
+    insufficientFunds = "insufficientFunds",
+    invalidOrangeMoneyNumber = "invalidOrangeMoneyNumber",
+    invalidData = "invalidData",
+    failedToInitiateThePayment = "failedToInitiateThePayment",
+    failedToGenerateAccessToken = "failedToGenerateAccessToken",
+    failedToCheckPaymentStatus = "failedToCheckPaymentStatus",
+    failedToGeneratePayToken = "failedToGeneratePayToken",
+    accountLocked = "accountLocked",
+    invalidPaymentAmount = "invalidPaymentAmount",
+    unauthorized = "unauthorized"
+}
+export declare enum OrangeMoneyErrorMessage {
+    beneficiaryNotFound = "Beneficiaire introuvable",
+    insufficientFunds = "Le solde du compte du payeur est insuffisant",
+    accountLocked = "Utilisateur bloque",
+    invalidPaymentAmount = "Vous avez saisi un montant superieur au montant maximum autorise"
+}
+//# sourceMappingURL=constants.d.ts.map

package/dist/orange_money/src/payments/utils/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/payments/utils/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,MAAM;IAChB,gBAAgB,kBAAkB;IAClC,YAAY,eAAe;IAC3B,cAAc,iBAAiB;IAC/B,aAAa,iBAAiB;IAC9B,cAAc,iBAAiB;IAC/B,WAAW,aAAa;IACxB,UAAU,aAAa;IACvB,YAAY,eAAe;IAC3B,YAAY,eAAe;IAC3B,eAAe,cAAc;IAC7B,OAAO,SAAS;IAChB,YAAY,cAAc;IAC1B,SAAS,WAAW;IACpB,WAAW,cAAc;IACzB,mBAAmB,qBAAqB;IACxC,oBAAoB,sBAAsB;IAC1C,cAAc,gBAAgB;IAC9B,gBAAgB,YAAY;IAC5B,MAAM,QAAQ;IACd,iBAAiB,aAAa;IAC9B,iBAAiB,aAAa;CAC/B;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAE/B,gBAAuB,QAAQ,sBAAsB;IAGrD,gBAAuB,WAAW,uCAAuC;IAGzE,gBAAuB,KAAK,YAAY;IAGxC,gBAAuB,aAAa,mBAAmB;IAGvD,gBAAuB,MAAM,aAAa;IAG1C,gBAAuB,SAAS,gBAAgB;IAGhD,gBAAuB,iBAAiB,wBAAwB;IAGhE,gBAAuB,UAAU,kBAAkB;CACpD;AAED;;GAEG;AACH,oBAAY,wBAAwB;IAClC;;;OAGG;IACH,eAAe,YAAY;IAE3B;;OAEG;IACH,iBAAiB,cAAc;IAE/B;;;OAGG;IACH,gBAAgB,cAAc;IAE9B;;OAEG;IACH,0BAA0B,gBAAgB;IAE1C;;OAEG;IACH,mBAAmB,YAAY;IAE/B;;;;;;OAMG;IACH,cAAc,WAAW;IAEzB;;;;OAIG;IACH,eAAe,YAAY;CAC5B;AAED,oBAAY,YAAY;IACtB,iBAAiB,sBAAsB;IACvC,wBAAwB,6BAA6B;IACrD,WAAW,gBAAgB;IAC3B,0BAA0B,+BAA+B;IACzD,2BAA2B,gCAAgC;IAC3D,0BAA0B,+BAA+B;IACzD,wBAAwB,6BAA6B;IACrD,aAAa,kBAAkB;IAC/B,oBAAoB,yBAAyB;IAC7C,YAAY,iBAAiB;CAC9B;AAED,oBAAY,uBAAuB;IACjC,mBAAmB,6BAA6B;IAChD,iBAAiB,iDAAiD;IAClE,aAAa,uBAAuB;IACpC,oBAAoB,qEAAqE;CAC1F"}

package/dist/orange_money/src/payments/utils/constants.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrangeMoneyErrorMessage = exports.ApiErrorType = exports.OrangeMoneyPaymentStatus = exports.ConstantRequestField = exports.ApiKey = void 0;
+var ApiKey;
+(function (ApiKey) {
+    ApiKey["keyAuthorization"] = "Authorization";
+    ApiKey["keyGrantType"] = "grant_type";
+    ApiKey["keyContentType"] = "Content-Type";
+    ApiKey["keyXAuthToken"] = "X-AUTH-TOKEN";
+    ApiKey["keyMerchantKey"] = "merchant_key";
+    ApiKey["keyCurrency"] = "currency";
+    ApiKey["keyOrderId"] = "order_id";
+    ApiKey["keyReturnUrl"] = "return_url";
+    ApiKey["keyCancelUrl"] = "cancel_url";
+    ApiKey["keyWebNotifyUrl"] = "notif_url";
+    ApiKey["keyLang"] = "lang";
+    ApiKey["keyReference"] = "reference";
+    ApiKey["keyAmount"] = "amount";
+    ApiKey["keyPayToken"] = "pay_token";
+    ApiKey["keySubscriberMsisdn"] = "subscriberMsisdn";
+    ApiKey["keyChannelUserMsisdn"] = "channelUserMsisdn";
+    ApiKey["keyDescription"] = "description";
+    ApiKey["keyMobileOrderId"] = "orderId";
+    ApiKey["keyPin"] = "pin";
+    ApiKey["keyMobilePayToken"] = "payToken";
+    ApiKey["keyMobileNotifUrl"] = "notifUrl";
+})(ApiKey || (exports.ApiKey = ApiKey = {}));
+/**
+ * Contains request fields.
+ */
+class ConstantRequestField {
+}
+exports.ConstantRequestField = ConstantRequestField;
+//  The content type field.
+ConstantRequestField.typeJson = 'application/json';
+// The url encode form.
+ConstantRequestField.TypeWwwFrom = 'application/x-www-form-urlencoded';
+// The basic authorization field.
+ConstantRequestField.basic = 'Basic ';
+//  The authorization field.
+ConstantRequestField.authorization = 'AUTHORIZATION';
+// The bearer field.
+ConstantRequestField.bearer = 'Bearer ';
+// The grant type field.
+ConstantRequestField.grantType = 'grant_type';
+//  The client credentials field.
+ConstantRequestField.clientCredentials = 'client_credentials';
+//  The X-AUTH-TOKEN field.
+ConstantRequestField.xAuthToken = 'X-AUTH-TOKEN';
+/**
+ * The orange money payment status.
+ */
+var OrangeMoneyPaymentStatus;
+(function (OrangeMoneyPaymentStatus) {
+    /**
+     * User has clicked on “Confirmed”, transaction
+     * is in progress on Orange system.
+     */
+    OrangeMoneyPaymentStatus["PENDING_PAYMENT"] = "PENDING";
+    /**
+     * The user canceled the payment.
+     */
+    OrangeMoneyPaymentStatus["CANCELLED_PAYMENT"] = "CANCELLED";
+    /**
+     * Waiting for user entry.
+     * Specially for web.
+     */
+    OrangeMoneyPaymentStatus["INITIATE_PAYMENT"] = "INITIATED";
+    /**
+     * Payment is done for mobile.
+     */
+    OrangeMoneyPaymentStatus["SUCCESSFULL_MOBILE_PAYMENT"] = "SUCCESSFULL";
+    /**
+     * Payment is done for web.
+     */
+    OrangeMoneyPaymentStatus["SUCCESS_WEB_PAYMENT"] = "SUCCESS";
+    /**
+     * Payment has failed.
+     * On web, the status can failed when user press to confirm payment too
+     * late or when user enter a wrong validation code.
+     * On mobile, it may fail when the user does not have a mooney orange wallet
+     * or the account balance is insufficient.
+     */
+    OrangeMoneyPaymentStatus["FAILED_PAYMENT"] = "FAILED";
+    /**
+     * User has clicked on “Confirmed” too late (after token’s validity), or the
+     * delay token timeout has expired.
+     * Note that the minimum token expiration time is 7 min.
+     */
+    OrangeMoneyPaymentStatus["EXPIRED_PAYMENT"] = "EXPIRED";
+})(OrangeMoneyPaymentStatus || (exports.OrangeMoneyPaymentStatus = OrangeMoneyPaymentStatus = {}));
+var ApiErrorType;
+(function (ApiErrorType) {
+    ApiErrorType["insufficientFunds"] = "insufficientFunds";
+    ApiErrorType["invalidOrangeMoneyNumber"] = "invalidOrangeMoneyNumber";
+    ApiErrorType["invalidData"] = "invalidData";
+    ApiErrorType["failedToInitiateThePayment"] = "failedToInitiateThePayment";
+    ApiErrorType["failedToGenerateAccessToken"] = "failedToGenerateAccessToken";
+    ApiErrorType["failedToCheckPaymentStatus"] = "failedToCheckPaymentStatus";
+    ApiErrorType["failedToGeneratePayToken"] = "failedToGeneratePayToken";
+    ApiErrorType["accountLocked"] = "accountLocked";
+    ApiErrorType["invalidPaymentAmount"] = "invalidPaymentAmount";
+    ApiErrorType["unauthorized"] = "unauthorized";
+})(ApiErrorType || (exports.ApiErrorType = ApiErrorType = {}));
+var OrangeMoneyErrorMessage;
+(function (OrangeMoneyErrorMessage) {
+    OrangeMoneyErrorMessage["beneficiaryNotFound"] = "Beneficiaire introuvable";
+    OrangeMoneyErrorMessage["insufficientFunds"] = "Le solde du compte du payeur est insuffisant";
+    OrangeMoneyErrorMessage["accountLocked"] = "Utilisateur bloque";
+    OrangeMoneyErrorMessage["invalidPaymentAmount"] = "Vous avez saisi un montant superieur au montant maximum autorise";
+})(OrangeMoneyErrorMessage || (exports.OrangeMoneyErrorMessage = OrangeMoneyErrorMessage = {}));
+//# sourceMappingURL=constants.js.map

package/dist/orange_money/src/payments/utils/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../src/payments/utils/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,MAsBX;AAtBD,WAAY,MAAM;IAChB,4CAAkC,CAAA;IAClC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,wCAA8B,CAAA;IAC9B,yCAA+B,CAAA;IAC/B,kCAAwB,CAAA;IACxB,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;IAC3B,qCAA2B,CAAA;IAC3B,uCAA6B,CAAA;IAC7B,0BAAgB,CAAA;IAChB,oCAA0B,CAAA;IAC1B,8BAAoB,CAAA;IACpB,mCAAyB,CAAA;IACzB,kDAAwC,CAAA;IACxC,oDAA0C,CAAA;IAC1C,wCAA8B,CAAA;IAC9B,sCAA4B,CAAA;IAC5B,wBAAc,CAAA;IACd,wCAA8B,CAAA;IAC9B,wCAA8B,CAAA;AAChC,CAAC,EAtBW,MAAM,sBAAN,MAAM,QAsBjB;AAED;;GAEG;AACH,MAAa,oBAAoB;;AAAjC,oDAwBC;AAvBC,2BAA2B;AACJ,6BAAQ,GAAG,kBAAkB,CAAC;AAErD,uBAAuB;AACA,gCAAW,GAAG,mCAAmC,CAAC;AAEzE,iCAAiC;AACV,0BAAK,GAAG,QAAQ,CAAC;AAExC,4BAA4B;AACL,kCAAa,GAAG,eAAe,CAAC;AAEvD,oBAAoB;AACG,2BAAM,GAAG,SAAS,CAAC;AAE1C,wBAAwB;AACD,8BAAS,GAAG,YAAY,CAAC;AAEhD,iCAAiC;AACV,sCAAiB,GAAG,oBAAoB,CAAC;AAEhE,2BAA2B;AACJ,+BAAU,GAAG,cAAc,CAAC;AAGrD;;GAEG;AACH,IAAY,wBA2CX;AA3CD,WAAY,wBAAwB;IAClC;;;OAGG;IACH,uDAA2B,CAAA;IAE3B;;OAEG;IACH,2DAA+B,CAAA;IAE/B;;;OAGG;IACH,0DAA8B,CAAA;IAE9B;;OAEG;IACH,sEAA0C,CAAA;IAE1C;;OAEG;IACH,2DAA+B,CAAA;IAE/B;;;;;;OAMG;IACH,qDAAyB,CAAA;IAEzB;;;;OAIG;IACH,uDAA2B,CAAA;AAC7B,CAAC,EA3CW,wBAAwB,wCAAxB,wBAAwB,QA2CnC;AAED,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,uDAAuC,CAAA;IACvC,qEAAqD,CAAA;IACrD,2CAA2B,CAAA;IAC3B,yEAAyD,CAAA;IACzD,2EAA2D,CAAA;IAC3D,yEAAyD,CAAA;IACzD,qEAAqD,CAAA;IACrD,+CAA+B,CAAA;IAC/B,6DAA6C,CAAA;IAC7C,6CAA6B,CAAA;AAC/B,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,2EAAgD,CAAA;IAChD,6FAAkE,CAAA;IAClE,+DAAoC,CAAA;IACpC,oHAAyF,CAAA;AAC3F,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC"}

package/dist/orange_money/src/payments/utils/joi_schema.d.ts

@@ -0,0 +1,70 @@
+import { LoggerInterface } from '../../utils/logging_interface';
+import { TargetEnvironment } from '../../utils/utils';
+import { OrangeMoneyPaymentStatus } from './constants';
+/**
+ * The provider generic response data of payment request of status verification request.
+ */
+export type GenericRequestResponseData = {
+    message: string;
+    data: {
+        id: number;
+        createtime: string | null;
+        subscriberMsisdn: string;
+        amount: number;
+        payToken: string;
+        txnid: string | null;
+        txnmode: string | null;
+        inittxnmessage: string;
+        inittxnstatus: string;
+        confirmtxnstatus: string | null;
+        confirmtxnmessage: string | null;
+        status: OrangeMoneyPaymentStatus;
+        notifUrl: string | null;
+        description: string | null;
+        channelUserMsisdn: string;
+    };
+};
+/**
+ * The provider generic response data of payment request of status verification request.
+ * We only make validation off fields that are required.
+ */
+export declare const genericRequestResponseSchema: any;
+export type InitPaymentBodySchema = {
+    orderId: string;
+    description: string;
+    orangeMoneyVersion?: string;
+    notifUrl: string;
+    pin: string;
+    payToken: string;
+    amount: number;
+    channelUserMsisdn: string;
+    subscriberMsisdn: string;
+};
+export declare const initPaymentBodySchema: any;
+export interface OrangeMoneyPaymentParams {
+    targetEnvironment: TargetEnvironment;
+    logger: LoggerInterface;
+    apiUserName: string;
+    apiPassword: string;
+    xAuthToken: string;
+    orangeMoneyVersion?: string;
+}
+/**
+ * The provider access token request response from the OM server.
+ */
+export type AccessTokenRequestResponse = {
+    access_token: string;
+    scope: string;
+    token_type: string;
+    expires_in: number;
+};
+/**
+ * The provider payToken request response from the OM server.
+ */
+export type PayTokenRequestResponse = {
+    message: string;
+    data: {
+        payToken: string;
+    };
+};
+//# sourceMappingURL=joi_schema.d.ts.map

package/dist/orange_money/src/payments/utils/joi_schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joi_schema.d.ts","sourceRoot":"","sources":["../../../../../src/payments/utils/joi_schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,MAAM,EAAE,wBAAwB,CAAC;QACjC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,KAoBrC,CAAC;AAEL,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,qBAAqB,KAoBhC,CAAC;AAEH,MAAM,WAAW,wBAAwB;IACvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,MAAM,EAAE,eAAe,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC"}

package/dist/orange_money/src/payments/utils/joi_schema.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initPaymentBodySchema = exports.genericRequestResponseSchema = void 0;
+const joi_1 = __importDefault(require("joi"));
+const constants_1 = require("./constants");
+/**
+ * The provider generic response data of payment request of status verification request.
+ * We only make validation off fields that are required.
+ */
+exports.genericRequestResponseSchema = joi_1.default.object({
+    message: joi_1.default.string().required(),
+    data: joi_1.default.object({
+        subscriberMsisdn: joi_1.default.string().required(),
+        amount: joi_1.default.number().required(),
+        inittxnmessage: joi_1.default.string().allow(null).allow('').required(),
+        status: joi_1.default.string()
+            .valid(constants_1.OrangeMoneyPaymentStatus.FAILED_PAYMENT, constants_1.OrangeMoneyPaymentStatus.PENDING_PAYMENT, constants_1.OrangeMoneyPaymentStatus.CANCELLED_PAYMENT, constants_1.OrangeMoneyPaymentStatus.EXPIRED_PAYMENT, constants_1.OrangeMoneyPaymentStatus.SUCCESSFULL_MOBILE_PAYMENT)
+            .required(),
+        channelUserMsisdn: joi_1.default.string().required(),
+    })
+        .required()
+        .unknown(true),
+});
+exports.initPaymentBodySchema = joi_1.default.object({
+    subscriberMsisdn: joi_1.default.string()
+        .required()
+        .pattern(/^(69\d{7}$|65[5-9]\d{6}$)/)
+        .message('[subscriberMsisdn] Invalid orange number. Format of valid number: 69******* or 65[5-9]******'),
+    channelUserMsisdn: joi_1.default.string()
+        .required()
+        .pattern(/^(69\d{7}$|65[5-9]\d{6}$)/)
+        .message('[channelUserMsisdn] Invalid orange number. Format of valid number: 69******* or 65[5-9]******'),
+    amount: joi_1.default.string().required(),
+    payToken: joi_1.default.string().required(),
+    pin: joi_1.default.string().max(4).required(),
+    notifUrl: joi_1.default.string().allow('').default(''),
+    orangeMoneyVersion: joi_1.default.string().optional(),
+    description: joi_1.default.string().allow('').max(125).default('payment'),
+    orderId: joi_1.default.string().max(20).required(),
+});
+//# sourceMappingURL=joi_schema.js.map

package/dist/orange_money/src/payments/utils/joi_schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joi_schema.js","sourceRoot":"","sources":["../../../../../src/payments/utils/joi_schema.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAsB;AAGtB,2CAAuD;AA0BvD;;;GAGG;AACU,QAAA,4BAA4B,GACvC,aAAG,CAAC,MAAM,CAA6B;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,aAAG,CAAC,MAAM,CAAC;QACf,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;QAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE;aACjB,KAAK,CACJ,oCAAwB,CAAC,cAAc,EACvC,oCAAwB,CAAC,eAAe,EACxC,oCAAwB,CAAC,iBAAiB,EAC1C,oCAAwB,CAAC,eAAe,EACxC,oCAAwB,CAAC,0BAA0B,CACpD;aACA,QAAQ,EAAE;QACb,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC3C,CAAC;SACC,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;CACjB,CAAC,CAAC;AAcQ,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAwB;IACrE,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC3B,QAAQ,EAAE;SACV,OAAO,CAAC,2BAA2B,CAAC;SACpC,OAAO,CACN,8FAA8F,CAC/F;IACH,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC5B,QAAQ,EAAE;SACV,OAAO,CAAC,2BAA2B,CAAC;SACpC,OAAO,CACN,+FAA+F,CAChG;IACH,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5C,kBAAkB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC/D,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC"}

package/dist/orange_money/src/payments/utils/request_model.d.ts

@@ -0,0 +1,75 @@
+import { OperationResponse } from '../../utils/operation_response';
+import { ApiErrorType, OrangeMoneyPaymentStatus } from './constants';
+import { AccessTokenRequestResponse, GenericRequestResponseData, PayTokenRequestResponse } from './joi_schema';
+export type InitializeOrangeMoneyRequest = {
+    /**
+     * The phone number of the user making the payment.
+     */
+    subscriberNumber: string;
+    /**
+     * The phone number of the user receiving the payment.
+     */
+    channelUserNumber: string;
+    /**
+     * Unique identifier of the customer transaction.
+     */
+    transactionId: string;
+    /**
+     * The amount of the transaction.
+     */
+    amount: number;
+    /**
+     * The Pin code of the ChannelUser.
+     */
+    pinCode: string;
+    /**
+     * An http endpoint able to receive a post request with the following json body.
+     * {
+     *  ”payToken” : ”payToken”,
+     *     ”status” : status”,
+     *    ”message” : ”message”
+     *  }
+     */
+    notifUrl?: string;
+    /**
+     * The payment description.
+     */
+    description?: string;
+    /**
+     * The payToken value useful to make payment
+     * and track the status of payment.
+     */
+    payToken: string;
+    /**
+     * The access token for authorize the request.
+     */
+    accessToken: string;
+};
+export type GetOrangeMoneyPaymentRequest = {
+    /**
+     * The access token for authorize the request.
+     */
+    accessToken: string;
+    /**
+     * unique identifier used to obtain payment status.
+     */
+    payToken: string;
+};
+/**
+ * This response is obtained when we initiate a mobile payment request,
+ * the request would generate a payToken useful to make payment
+ * and track the status of payment.
+ */
+export type InitializeOrangeMoneyResponse = OperationResponse<{
+    /**
+     * The payToken value useful to make payment
+     * and track the status of payment.
+     */
+    payToken: string;
+}, GenericRequestResponseData, ApiErrorType>;
+export type GetOrangeMoneyPaymentResponse = OperationResponse<{
+    status: OrangeMoneyPaymentStatus;
+}, GenericRequestResponseData, ApiErrorType>;
+export type GetAccessTokenResponse = OperationResponse<string, AccessTokenRequestResponse | undefined, ApiErrorType>;
+export type GetPayTokenResponse = OperationResponse<string, PayTokenRequestResponse | undefined, ApiErrorType>;
+//# sourceMappingURL=request_model.d.ts.map

package/dist/orange_money/src/payments/utils/request_model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request_model.d.ts","sourceRoot":"","sources":["../../../../../src/payments/utils/request_model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACxB,MAAM,cAAc,CAAC;AAEtB,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAC3D;IACE;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,EACD,0BAA0B,EAC1B,YAAY,CACb,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAC3D;IACE,MAAM,EAAE,wBAAwB,CAAC;CAClC,EACD,0BAA0B,EAC1B,YAAY,CACb,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CACpD,MAAM,EACN,0BAA0B,GAAG,SAAS,EACtC,YAAY,CACb,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,CACjD,MAAM,EACN,uBAAuB,GAAG,SAAS,EACnC,YAAY,CACb,CAAC"}

package/dist/orange_money/src/payments/utils/request_model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=request_model.js.map

package/dist/orange_money/src/payments/utils/request_model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request_model.js","sourceRoot":"","sources":["../../../../../src/payments/utils/request_model.ts"],"names":[],"mappings":""}

package/dist/orange_money/src/payments/utils/utils.d.ts

@@ -0,0 +1,15 @@
+import Joi from 'joi';
+/**
+ * Checks if the data is valid type.
+ * @param {Record<string, unknown>} data .
+ * @param {Joi.PartialSchemaMap<T>} schema .
+ * @return {Record<string, unknown>}
+ */
+export declare function validateData<T>(data: unknown, schema: Joi.ObjectSchema<T>): {
+    isValidData: true;
+    data: T;
+} | {
+    isValidData: false;
+    message: string;
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/orange_money/src/payments/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../src/payments/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,IAAI,EAAE,OAAO,EACb,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAC1B;IAAE,WAAW,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAmB1E"}

package/dist/orange_money/src/payments/utils/utils.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateData = void 0;
+/**
+ * Checks if the data is valid type.
+ * @param {Record<string, unknown>} data .
+ * @param {Joi.PartialSchemaMap<T>} schema .
+ * @return {Record<string, unknown>}
+ */
+function validateData(data, schema) {
+    const { error, value } = schema.unknown(true).validate(data, {
+        abortEarly: false,
+        convert: false,
+    });
+    if (error) {
+        return {
+            isValidData: false,
+            message: JSON.stringify(error.details.map((e) => e.message), null, ' '),
+        };
+    }
+    return {
+        isValidData: true,
+        data: value,
+    };
+}
+exports.validateData = validateData;
+//# sourceMappingURL=utils.js.map

package/dist/orange_money/src/payments/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../src/payments/utils/utils.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,IAAa,EACb,MAA2B;IAE3B,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE;QAC3D,UAAU,EAAE,KAAK;QACjB,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IACH,IAAI,KAAK,EAAE,CAAC;QACV,OAAO;YACL,WAAW,EAAE,KAAK;YAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CACrB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EACnC,IAAI,EACJ,GAAG,CACJ;SACF,CAAC;IACJ,CAAC;IACD,OAAO;QACL,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,KAAK;KACZ,CAAC;AACJ,CAAC;AAtBD,oCAsBC"}

package/dist/orange_money/src/utils/https.d.ts

@@ -0,0 +1,77 @@
+import { LoggerInterface } from './logging_interface';
+export declare enum RequestStatusCode {
+    unauthorized = 401,
+    expectationFailed = 417
+}
+export type RequestResponse<T> = {
+    response?: {
+        data: T;
+        status: number;
+    };
+    error?: unknown;
+};
+/**
+ * Posts an http request to the given route.
+ * @param {Record<string, string | undefined> | string} data The data to be posted.
+ * @param {string} route The end point url.
+ * @param {Record<string, string>} headers The type content  of request.
+ * @param {LoggerInterface} logger The logger to use when posting data.
+ * @return {Promise<unknown | undefined>} The server response.
+ */
+export declare function postRequest<T>({ data, route, headers, logger, rejectUnauthorized, }: {
+    data?: Record<string, unknown> | string | null;
+    route: string;
+    logger: LoggerInterface;
+    headers?: Record<string, string>;
+    rejectUnauthorized?: boolean;
+}): Promise<RequestResponse<T>>;
+/**
+ * Gets an http request to the given route.
+ * @param {Record<string, string | undefined> | string} data The data to be posted.
+ * @param {string} route The end point url.
+ * @param {Record<string, string>} headers The type content  of request.
+ * @param {LoggerInterface} logger The logger to use when getting data.
+ * @return {Promise<unknown | undefined>} The server response.
+ */
+export declare function getRequest<T>({ data, route, headers, logger, rejectUnauthorized, }: {
+    data?: Record<string, string | undefined> | string;
+    route: string;
+    headers?: Record<string, string>;
+    logger: LoggerInterface;
+    rejectUnauthorized?: boolean;
+}): Promise<RequestResponse<T>>;
+/**
+ * Parses an Axios error and returns a modified error object.
+ *
+ * @param {unknown} error - The error object to be parsed.
+ * @return {unknown} The modified error object.
+ */
+export declare function parseAxiosError(error: unknown): unknown;
+/**
+ * Generates a hash using the given key and secret.
+ *
+ * @param {string} key - The key to be hashed.
+ * @param {string} secret - The secret to be hashed.
+ * @return {string} - The generated hash.
+ */
+export declare function hash(key: string, secret: string): string;
+/**
+ * Encode the body of the request.
+ * @param {Record<string, string>} bodyRequest the body request.
+ * @return {string} the encoded body request result.
+ */
+export declare function encodeTheBodyOfRequest(bodyRequest: Record<string, string>): string;
+export declare const encodeToBase64: (apiUsername: string, apiPassword: string) => string;
+/**
+ * Encode the data to w3 x form encoded url.
+ * @param {Record<string, string>} data the data to encode.
+ * @return {string} the encoded value.
+ */
+export declare function encodeDataToXFormUrl(data: Record<string, string>): string;
+/**
+ * Checks if the code is a successful code response.
+ * @param {num} code .
+ * @return {boolean} true if the code is valid.
+ */
+export declare const isSuccessfulCodeResponse: (code: number) => boolean;
+//# sourceMappingURL=https.d.ts.map

package/dist/orange_money/src/utils/https.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"https.d.ts","sourceRoot":"","sources":["../../../../src/utils/https.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,oBAAY,iBAAiB;IAC3B,YAAY,MAAM;IAClB,iBAAiB,MAAM;CACxB;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAC/B,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,CAAC,CAAC;QACR,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,CAAC,EAAE,EACnC,IAAI,EACJ,KAAK,EACL,OAAO,EACP,MAAM,EACN,kBAAyB,GAC1B,EAAE;IACD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAmD9B;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,CAAC,EAAE,EAClC,IAAI,EACJ,KAAK,EACL,OAAO,EACP,MAAM,EACN,kBAAyB,GAC1B,EAAE;IACD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,CAAC;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,EAAE,eAAe,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAmD9B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CA2BvD;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMxD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAClC,MAAM,CAUR;AAGD,eAAO,MAAM,cAAc,gBACZ,MAAM,eACN,MAAM,KAClB,MAEF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAUzE;AAED;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,SAAU,MAAM,KAAG,OAC7B,CAAC"}