@payhos/api 0.0.1

package/README.md

@@ -0,0 +1,30 @@
+# PayHos API SDK
+
+[PayHos](https://payhos.com) is an easy go-to solution to many day-to-day fintech problems by providing an easily accessible opportunities to all and sundry with minimal bar of entry. It is provided by [EmbyBest Concept Nig. Ltd](https://embyconcept.com)
+
+This API SDK is intended to assist web applications of any kind to interact with the PayHos API server by utilizing its simple schematics. For a more modular usage, this library is designed such that bundlers with tree-shaking is enhanced.
+
+## Installation
+Install @payhos/api via npm by running the following command: 
+> `npm install @payhos/api --save`
+
+## Usage
+Create an instance and call available methods from the instance created.
+
+ ```typescript
+import {  } from '@payhos/api';
+
+const payHos = new PayHos();
+ ``` 
+
+## SMS
+```typescript
+// comment
+const doc = {};
+```
+
+### Further Reading
+Have a look at other packages:
+- [pincode](https://www.npmjs.com/package/pincode)
+- [timestamp-date](https://www.npmjs.com/package/timestamp-date)
+- [ng-sub](https://www.npmjs.com/package/ng-sub)

package/index.d.ts

@@ -0,0 +1,7 @@
+import { PayHosAirtime } from './modules/airtime';
+import { PayHosSMS } from './modules/sms';
+export declare class PayHos {
+    sms: PayHosSMS;
+    airtime: PayHosAirtime;
+    constructor(tkn: string);
+}

package/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHos = void 0;
+const airtime_1 = require("./modules/airtime");
+const sms_1 = require("./modules/sms");
+const api_service_1 = require("./services/api.service");
+class PayHos {
+    constructor(tkn) {
+        const client = new api_service_1.PayHosApiClient(tkn);
+        this.sms = new sms_1.PayHosSMS(client);
+        this.airtime = new airtime_1.PayHosAirtime(client);
+    }
+}
+exports.PayHos = PayHos;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+CAAkD;AAClD,uCAA0C;AAC1C,wDAAyD;AAEzD,MAAa,MAAM;IAIjB,YAAY,GAAW;QACrB,MAAM,MAAM,GAAG,IAAI,6BAAe,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,CAAC,GAAG,GAAG,IAAI,eAAS,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAa,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF;AAVD,wBAUC"}

package/models/index.d.ts

@@ -0,0 +1,9 @@
+export interface Map<T> {
+    [key: string]: T;
+}
+export interface ApiResponse<T> {
+    success: boolean;
+    data?: T;
+    message?: string;
+    stackTrace?: any;
+}

package/models/index.js

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

package/models/index.js.map

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

package/modules/airtime/index.d.ts

@@ -0,0 +1,5 @@
+import { PayHosApiClient } from '../../services/api.service';
+export declare class PayHosAirtime {
+    private client;
+    constructor(c: PayHosApiClient);
+}

package/modules/airtime/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHosAirtime = void 0;
+class PayHosAirtime {
+    constructor(c) {
+        this.client = c;
+        console.log(this.client);
+    }
+}
+exports.PayHosAirtime = PayHosAirtime;
+//# sourceMappingURL=index.js.map

package/modules/airtime/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/airtime/index.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAGxB,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAEhB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;CACF;AARD,sCAQC"}

package/modules/sms/index.d.ts

@@ -0,0 +1,6 @@
+import { PayHosApiClient } from '../../services/api.service';
+export declare class PayHosSMS {
+    private client;
+    constructor(c: PayHosApiClient);
+    send(msg: string, recipients: string[], flash?: boolean): Promise<{}>;
+}

package/modules/sms/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHosSMS = void 0;
+const utilities_service_1 = require("../../services/utilities.service");
+class PayHosSMS {
+    constructor(c) {
+        this.client = c;
+    }
+    send(msg, recipients, flash) {
+        const body = {
+            message: msg,
+            recipients: recipients.map(r => (0, utilities_service_1.formatPhoneNumber)(r)),
+            flash,
+        };
+        return this.client.postApi('/sms/send', body);
+    }
+}
+exports.PayHosSMS = PayHosSMS;
+//# sourceMappingURL=index.js.map

package/modules/sms/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/sms/index.ts"],"names":[],"mappings":";;;AAAA,wEAAqE;AAGrE,MAAa,SAAS;IAGpB,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEM,IAAI,CAAC,GAAW,EAAE,UAAoB,EAAE,KAAe;QAC5D,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,GAAG;YACZ,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,qCAAiB,EAAC,CAAC,CAAC,CAAC;YACrD,KAAK;SACN,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;CACF;AAhBD,8BAgBC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@payhos/api",
+  "description": "An API SDK to communicate with the PayHos API",
+  "version": "0.0.1",
+  "main": "index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "test": "mocha --require ts-node/register test/**/*.ts",
+    "deploy": "tsc && node copy && cd dist && npm publish --access=public",
+    "unpublish": "npm unpublish @payhos/api@0.0.1"
+  },
+  "dependencies": {
+    "axios": "^0.26.1"
+  },
+  "author": {
+    "name": "Moses Godson",
+    "email": "mosesgodson27@gmail.com"
+  },
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Moses270/@payhos/api/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Moses270/@payhos/api"
+  },
+  "homepage": "https://payhos.com",
+  "keywords": [
+    "PayHos",
+    "API",
+    "SMS",
+    "Airtime",
+    "Data subscription",
+    "Electricity bills"
+  ],
+  "devDependencies": {
+    "fs-extra": "^9.0.0",
+    "tslib": "^2.3.1"
+  }
+}

package/services/api.service.d.ts

@@ -0,0 +1,13 @@
+import { Map } from '../models';
+export declare class PayHosApiClient {
+    private token;
+    private baseUrl;
+    constructor(tkn: string);
+    private config;
+    private toUrl;
+    private handleApiResponse;
+    getApi<T>(url: string, params?: Map<string>): Promise<T>;
+    postApi<T>(url: string, body: Map<any>, params?: Map<string>): Promise<T>;
+    putApi<T>(url: string, body: Map<any>, params?: Map<string>): Promise<T>;
+    deleteApi<T>(url: string, params?: Map<string>): Promise<T>;
+}

package/services/api.service.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHosApiClient = void 0;
+const axios_1 = require("axios");
+class PayHosApiClient {
+    constructor(tkn) {
+        this.baseUrl = 'https://us-central1-pay-hos.cloudfunctions.net/apiHttp/api/v1';
+        this.token = tkn;
+    }
+    config() {
+        if (!this.token) {
+            throw Error('API token must be provided');
+        }
+        const config = {
+            headers: {
+                'Authorization': 'Bearer ' + this.token,
+            },
+        };
+        return config;
+    }
+    toUrl(url, params) {
+        let result = this.baseUrl + '/' + url.substring(url.startsWith('/') ? 1 : 0) + '?';
+        const pms = params || {};
+        pms._phos_now = Date.now().toString();
+        const keys = Object.keys(pms);
+        for (const k of keys) {
+            result += `${k}=${params[k]}&`;
+        }
+        return result.substring(0, result.length - 1);
+    }
+    handleApiResponse(promise) {
+        return new Promise((resolve, reject) => {
+            promise.then(res => {
+                if (res.success) {
+                    resolve(res.data);
+                }
+                else {
+                    reject(res.message || res.stackTrace || 'Error encountered!');
+                }
+            }).catch(e => {
+                reject(e);
+            });
+        });
+    }
+    getApi(url, params) {
+        return this.handleApiResponse(axios_1.default.get(this.toUrl(url, params), this.config()));
+    }
+    async postApi(url, body, params) {
+        return this.handleApiResponse(axios_1.default.post(this.toUrl(url, params), body, this.config()));
+    }
+    async putApi(url, body, params) {
+        return this.handleApiResponse(axios_1.default.put(this.toUrl(url, params), body, this.config()));
+    }
+    async deleteApi(url, params) {
+        return this.handleApiResponse(axios_1.default.delete(this.toUrl(url, params), this.config()));
+    }
+}
+exports.PayHosApiClient = PayHosApiClient;
+//# sourceMappingURL=api.service.js.map

package/services/api.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.service.js","sourceRoot":"","sources":["../../src/services/api.service.ts"],"names":[],"mappings":";;;AAAA,iCAA0B;AAG1B,MAAa,eAAe;IAI1B,YAAY,GAAW;QAFf,YAAO,GAAG,+DAA+D,CAAC;QAGhF,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;IACnB,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC3C;QAED,MAAM,MAAM,GAAG;YACb,OAAO,EAAE;gBACP,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC,KAAK;aACxC;SACF,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,GAAW,EAAE,MAAoB;QAC7C,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,GAAG,GAAG,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;QAEnF,MAAM,GAAG,GAAG,MAAM,IAAI,EAAE,CAAC;QACzB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QAEtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;YACpB,MAAM,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;SAChC;QAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAEO,iBAAiB,CAAI,OAAgC;QAC3D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACjB,IAAI,GAAG,CAAC,OAAO,EAAE;oBACf,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBACnB;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,UAAU,IAAI,oBAAoB,CAAC,CAAC;iBAC/D;YACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBACX,MAAM,CAAC,CAAC,CAAC,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAI,GAAW,EAAE,MAAoB;QAChD,OAAO,IAAI,CAAC,iBAAiB,CAC3B,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAClD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,OAAO,CAAI,GAAW,EAAE,IAAc,EAAE,MAAoB;QACvE,OAAO,IAAI,CAAC,iBAAiB,CAC3B,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CACzD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,IAAc,EAAE,MAAoB;QACtE,OAAO,IAAI,CAAC,iBAAiB,CAC3B,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CACxD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS,CAAI,GAAW,EAAE,MAAoB;QACzD,OAAO,IAAI,CAAC,iBAAiB,CAC3B,eAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CACrD,CAAC;IACJ,CAAC;CACF;AAzED,0CAyEC"}

package/services/utilities.service.d.ts

@@ -0,0 +1 @@
+export declare const formatPhoneNumber: (phone: string) => string;

package/services/utilities.service.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPhoneNumber = void 0;
+const formatPhoneNumber = (phone) => {
+    let phoneNumber;
+    if (phone.startsWith('0')) {
+        phoneNumber = phone;
+    }
+    else if (phone.startsWith('234')) {
+        phoneNumber = '0' + phone.substring(3);
+    }
+    else if (phone.startsWith('+234')) {
+        phoneNumber = '0' + phone.substring(4);
+    }
+    else {
+        return '';
+    }
+    // removes space from with number characters
+    phoneNumber = phoneNumber.replace(new RegExp(' ', 'g'), '');
+    const noNonDigit = !(/\D/i.test(phoneNumber));
+    if (phoneNumber.length === 11 && noNonDigit) {
+        return phoneNumber;
+    }
+    else {
+        return '';
+    }
+};
+exports.formatPhoneNumber = formatPhoneNumber;
+//# sourceMappingURL=utilities.service.js.map

package/services/utilities.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.service.js","sourceRoot":"","sources":["../../src/services/utilities.service.ts"],"names":[],"mappings":";;;AAAO,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAU,EAAE;IACzD,IAAI,WAAmB,CAAC;IAExB,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,GAAG,KAAK,CAAC;KACrB;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;QAClC,WAAW,GAAG,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;KACxC;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QACnC,WAAW,GAAG,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;KACxC;SAAM;QACL,OAAO,EAAE,CAAC;KACX;IAED,4CAA4C;IAC5C,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9C,IAAI,WAAW,CAAC,MAAM,KAAK,EAAE,IAAI,UAAU,EAAE;QAC3C,OAAO,WAAW,CAAC;KACpB;SAAM;QACL,OAAO,EAAE,CAAC;KACX;AACH,CAAC,CAAA;AAtBY,QAAA,iBAAiB,qBAsB7B"}

package/test.d.ts

@@ -0,0 +1 @@
+export {};

package/test.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const app = new index_1.PayHos('TOKEN_STRING');
+console.log(app.sms);
+//# sourceMappingURL=test.js.map

package/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;AAAA,mCAAiC;AAEjC,MAAM,GAAG,GAAG,IAAI,cAAM,CAAC,cAAc,CAAC,CAAC;AACvC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC"}