@payhos/api 0.2.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # 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)
+[PayHos](https://payhos.com) is an easy go-to solution for many day-to-day fintech problems by providing an easily accessible opportunities to all and sundry with minimal bar of entry. For a full documentations of PayHos API and fully supported features, visit [PayHos API Docs](https://docs.payhos.com) 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.
 
@@ -22,16 +22,18 @@ const payhos = new PayHos('<YOUR API TOKEN>');
 // You can access each of PayHos' API features as follows:
 const sms = payhos.sms;
 const airtime = payhos.airtime;
+const email = payhos.email;
  ``` 
 
 ## Airtime
 ```javascript
 const airtime = payhos.airtime;
 
-// still under construction...
+// Coming soon...
 ```
 
 ## SMS
+Visit [Send SMS with PayHos](https://docs.payhos.com/components/sms) for more information on SMS dodumentations.
 ```javascript
 const sms = payhos.sms;
 const data = {
@@ -50,6 +52,33 @@ sms.send(data).then(response => {
 });
 ```
 
+## Email
+For detailed documentations on sending emails with PayHos API and other supported SDKs, visit [Sending Emails](https://docs.payhos.com/components/email) with PayHos
+```javascript
+const email = payhos.email;
+const data = {
+  subject: 'Test Email',
+  content: `Hey <strong>Alice</strong>, this is a test email message from <a href="https://payhos.com">PayHos API Hub</a>`,
+  customData: {},
+  recipients: [
+    {email: 'example@example.com'},
+    { name: 'Alice', email: 'example2@example.com' }
+  ],
+  from: {
+    name: 'PayHos',
+    email: 'test@test.com'
+  }
+};
+
+// to send email
+email.send(data).then(response => {
+  // message(s) sent successfully
+  console.log(response);
+}).catch(err => {
+  console.log(err);
+});
+```
+
 ### Further Reading
 Have a look at other packages:
 - [pincode](https://www.npmjs.com/package/pincode)

package/index.d.ts

@@ -1,7 +1,12 @@
-import { PayHosAirtime } from './modules/airtime';
-import { PayHosSMS } from './modules/sms';
-export declare class PayHos {
-    sms: PayHosSMS;
-    airtime: PayHosAirtime;
-    constructor(tkn: string);
-}
+import { PayHosAirtimeClient } from './modules/airtime';
+import { PayHosEmailClient } from './modules/email';
+import { PayHosSMSClient } from './modules/sms';
+import { PayHosUtilitiesClient } from './modules/utilities';
+export declare class PayHos {
+    sms: PayHosSMSClient;
+    airtime: PayHosAirtimeClient;
+    email: PayHosEmailClient;
+    utilities: PayHosUtilitiesClient;
+    constructor(tkn: string);
+}
+export * from './models';

package/index.js

@@ -1,15 +1,22 @@
-"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;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHos = void 0;
+const tslib_1 = require("tslib");
+const airtime_1 = require("./modules/airtime");
+const email_1 = require("./modules/email");
+const sms_1 = require("./modules/sms");
+const utilities_1 = require("./modules/utilities");
+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.PayHosSMSClient(client);
+        this.airtime = new airtime_1.PayHosAirtimeClient(client);
+        this.email = new email_1.PayHosEmailClient(client);
+        this.utilities = new utilities_1.PayHosUtilitiesClient(client);
+    }
+}
+exports.PayHos = PayHos;
+// export models
+tslib_1.__exportStar(require("./models"), exports);
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,+CAAwD;AACxD,2CAAoD;AACpD,uCAAgD;AAChD,mDAA4D;AAC5D,wDAAyD;AAEzD,MAAa,MAAM;IAMjB,YAAY,GAAW;QACrB,MAAM,MAAM,GAAG,IAAI,6BAAe,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,CAAC,GAAG,GAAG,IAAI,qBAAe,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,6BAAmB,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,yBAAiB,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAqB,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;CACF;AAdD,wBAcC;AAED,gBAAgB;AAChB,mDAAyB"}

package/models/index.d.ts

@@ -1,15 +1,29 @@
-export interface Map<T> {
-    [key: string]: T;
-}
-export interface ApiResponse<T> {
-    success: boolean;
-    data?: T;
-    message?: string;
-    stackTrace?: any;
-}
-export interface PayHosSMSPayload {
-    message: string;
-    recipients: string[];
-    flash?: boolean;
-    senderId?: string;
-}
+export interface Map<T> {
+    [key: string]: T;
+}
+export interface ApiResponse<T> {
+    success: boolean;
+    data?: T;
+    message?: string;
+    stackTrace?: any;
+}
+export interface PayHosSMSPayload {
+    message: string;
+    recipients: string[];
+    flash?: boolean;
+    senderId?: string;
+}
+export interface EmailRecipient {
+    name?: string;
+    email: string;
+}
+export interface PayhosEmailPayload {
+    recipients: EmailRecipient[] | string[];
+    from?: EmailRecipient;
+    subject: string;
+    content: string;
+    customData?: Map<any>;
+}
+export interface ServerTimeResponse {
+    timestamp: Date;
+}

package/models/index.js

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

package/modules/airtime/index.d.ts

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

package/modules/airtime/index.js

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

package/modules/airtime/index.js.map

@@ -1 +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,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG;IACvB,CAAC;CACF;AARD,sCAQC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/airtime/index.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAG9B,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAEhB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG;IACvB,CAAC;CACF;AARD,kDAQC"}

package/modules/email/index.d.ts

@@ -0,0 +1,8 @@
+import { PayHosApiClient } from '../../services/api.service';
+import { ApiResponse, PayhosEmailPayload } from '../../models';
+export declare class PayHosEmailClient {
+    private client;
+    constructor(c: PayHosApiClient);
+    private url;
+    send(data: PayhosEmailPayload): Promise<ApiResponse<string>>;
+}

package/modules/email/index.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHosEmailClient = void 0;
+class PayHosEmailClient {
+    constructor(c) {
+        this.client = c;
+    }
+    url(path) {
+        return '/email/' + path.substring(path.startsWith('/') ? 1 : 0);
+    }
+    send(data) {
+        return new Promise(resolve => {
+            const body = {
+                content: data.content,
+                subject: data.subject,
+                customData: data.customData || {},
+                from: data.from || { email: 'noreply@payhos.com' },
+                recipients: (data.recipients || []).map((r) => {
+                    if (r === null || r === void 0 ? void 0 : r.email) {
+                        return r;
+                    }
+                    return { name: '', email: (r === null || r === void 0 ? void 0 : r.toString()) || '' };
+                }),
+            };
+            this.client.postApi(this.url('send'), body).then(res => {
+                resolve(res);
+            }).catch(e => {
+                if (e === null || e === void 0 ? void 0 : e.error) {
+                    resolve(e.error);
+                }
+                else {
+                    console.error(e);
+                }
+            });
+        });
+    }
+}
+exports.PayHosEmailClient = PayHosEmailClient;
+//# sourceMappingURL=index.js.map

package/modules/email/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/email/index.ts"],"names":[],"mappings":";;;AAGA,MAAa,iBAAiB;IAG5B,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEO,GAAG,CAAC,IAAY;QACtB,OAAO,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;IAEM,IAAI,CAAC,IAAwB;QAClC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,MAAM,IAAI,GAAuB;gBAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,EAAE;gBACjC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE;gBAClD,UAAU,EAAE,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE;oBACjD,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;wBACZ,OAAO,CAAC,CAAC;qBACV;oBAED,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,EAAE,KAAI,EAAE,EAAE,CAAA;gBACjD,CAAC,CAAC;aACH,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAC1E,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBACX,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;oBACZ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;iBAClB;qBAAM;oBACL,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBAClB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAtCD,8CAsCC"}

package/modules/sms/index.d.ts

@@ -1,7 +1,8 @@
-import { PayHosApiClient } from '../../services/api.service';
-import { ApiResponse, PayHosSMSPayload } from '../../models';
-export declare class PayHosSMS {
-    private client;
-    constructor(c: PayHosApiClient);
-    send(data: PayHosSMSPayload): Promise<ApiResponse<string>>;
-}
+import { PayHosApiClient } from '../../services/api.service';
+import { ApiResponse, PayHosSMSPayload } from '../../models';
+export declare class PayHosSMSClient {
+    private client;
+    constructor(c: PayHosApiClient);
+    private url;
+    send(data: PayHosSMSPayload): Promise<ApiResponse<string>>;
+}

package/modules/sms/index.js

@@ -1,30 +1,33 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayHosSMS = void 0;
-class PayHosSMS {
-    constructor(c) {
-        this.client = c;
-    }
-    send(data) {
-        return new Promise(resolve => {
-            const body = {
-                message: data.message,
-                recipients: data.recipients || [],
-                flash: data.flash || false,
-                senderId: data.senderId || 'PayHos',
-            };
-            this.client.postApi('/sms/send', body).then(res => {
-                resolve(res);
-            }).catch(e => {
-                if (e === null || e === void 0 ? void 0 : e.error) {
-                    resolve(e.error);
-                }
-                else {
-                    console.error(e);
-                }
-            });
-        });
-    }
-}
-exports.PayHosSMS = PayHosSMS;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHosSMSClient = void 0;
+class PayHosSMSClient {
+    constructor(c) {
+        this.client = c;
+    }
+    url(path) {
+        return '/sms/' + path.substring(path.startsWith('/') ? 1 : 0);
+    }
+    send(data) {
+        return new Promise(resolve => {
+            const body = {
+                message: data.message,
+                recipients: data.recipients || [],
+                flash: data.flash || false,
+                senderId: data.senderId || 'PayHos',
+            };
+            this.client.postApi(this.url('send'), body).then(res => {
+                resolve(res);
+            }).catch(e => {
+                if (e === null || e === void 0 ? void 0 : e.error) {
+                    resolve(e.error);
+                }
+                else {
+                    console.error(e);
+                }
+            });
+        });
+    }
+}
+exports.PayHosSMSClient = PayHosSMSClient;
 //# sourceMappingURL=index.js.map

package/modules/sms/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/sms/index.ts"],"names":[],"mappings":";;;AAGA,MAAa,SAAS;IAGpB,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEM,IAAI,CAAC,IAAsB;QAChC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,MAAM,IAAI,GAAqB;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,EAAE;gBACjC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,KAAK;gBAC1B,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ;aACpC,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsB,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACrE,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBACX,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;oBACZ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;iBAClB;qBAAM;oBACL,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBAClB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,8BA2BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/sms/index.ts"],"names":[],"mappings":";;;AAGA,MAAa,eAAe;IAG1B,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEO,GAAG,CAAC,IAAY;QACtB,OAAO,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;IAEM,IAAI,CAAC,IAAsB;QAChC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,MAAM,IAAI,GAAqB;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,EAAE;gBACjC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,KAAK;gBAC1B,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ;aACpC,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAC1E,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBACX,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;oBACZ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;iBAClB;qBAAM;oBACL,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBAClB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA/BD,0CA+BC"}

package/modules/utilities/index.d.ts

@@ -0,0 +1,8 @@
+import { PayHosApiClient } from '../../services/api.service';
+import { ApiResponse, ServerTimeResponse } from '../../models';
+export declare class PayHosUtilitiesClient {
+    private client;
+    constructor(c: PayHosApiClient);
+    private url;
+    serverTime(): Promise<ApiResponse<ServerTimeResponse>>;
+}

package/modules/utilities/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayHosUtilitiesClient = void 0;
+class PayHosUtilitiesClient {
+    constructor(c) {
+        this.client = c;
+    }
+    url(path) {
+        return '/utilities/' + path.substring(path.startsWith('/') ? 1 : 0);
+    }
+    serverTime() {
+        return new Promise(resolve => {
+            this.client.getApi(this.url('date')).then(res => {
+                resolve(res);
+            }).catch(e => {
+                if (e === null || e === void 0 ? void 0 : e.error) {
+                    resolve(e.error);
+                }
+                else {
+                    console.error(e);
+                }
+            });
+        });
+    }
+}
+exports.PayHosUtilitiesClient = PayHosUtilitiesClient;
+//# sourceMappingURL=index.js.map

package/modules/utilities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/utilities/index.ts"],"names":[],"mappings":";;;AAGA,MAAa,qBAAqB;IAGhC,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEO,GAAG,CAAC,IAAY;QACtB,OAAO,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAkC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAC/E,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBACX,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;oBACZ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;iBAClB;qBAAM;oBACL,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBAClB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,sDAwBC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@payhos/api",
   "description": "An API SDK to communicate with the PayHos API",
-  "version": "0.2.0",
+  "version": "1.0.1",
   "main": "index.js",
   "typings": "index.d.ts",
   "scripts": {
@@ -28,8 +28,9 @@
   "keywords": [
     "PayHos",
     "API",
-    "SMS",
-    "Airtime",
+    "SMS API",
+    "Airtime API",
+    "Emails API",
     "Data subscription",
     "Electricity bills"
   ],

package/services/api.service.d.ts

@@ -1,13 +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>;
-}
+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

@@ -1,60 +1,60 @@
-"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: {
-                'PAYHOS_API_TOKEN': 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}=${pms[k]}&`;
-        }
-        return result.substring(0, result.length - 1);
-    }
-    handleApiResponse(promise) {
-        return new Promise((resolve, reject) => {
-            promise.then(res => {
-                var _a;
-                if ((_a = res.data) === null || _a === void 0 ? void 0 : _a.success) {
-                    resolve(res.data.data);
-                }
-                else {
-                    reject(res.data.message || res.data.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;
+"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/apiServerFn/api/v1';
+        this.token = tkn;
+    }
+    config() {
+        if (!this.token) {
+            throw Error('API token must be provided');
+        }
+        const config = {
+            headers: {
+                'X-PAYHOS_API_TOKEN': 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}=${pms[k]}&`;
+        }
+        return result.substring(0, result.length - 1);
+    }
+    handleApiResponse(promise) {
+        return new Promise((resolve, reject) => {
+            promise.then(res => {
+                var _a;
+                if ((_a = res.data) === null || _a === void 0 ? void 0 : _a.success) {
+                    resolve(res.data.data);
+                }
+                else {
+                    reject(res.data.message || res.data.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

@@ -1 +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,kBAAkB,EAAE,IAAI,CAAC,KAAK;aAC/B;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,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;SAC7B;QAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAEO,iBAAiB,CAAI,OAA0C;QACrE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;;gBACjB,IAAI,MAAA,GAAG,CAAC,IAAI,0CAAE,OAAO,EAAE;oBACrB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACxB;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,CAAC;iBACzE;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"}
+{"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,mEAAmE,CAAC;QAGpF,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,oBAAoB,EAAE,IAAI,CAAC,KAAK;aACjC;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,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;SAC7B;QAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAEO,iBAAiB,CAAI,OAA0C;QACrE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;;gBACjB,IAAI,MAAA,GAAG,CAAC,IAAI,0CAAE,OAAO,EAAE;oBACrB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACxB;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,CAAC;iBACzE;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

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

package/services/utilities.service.js

@@ -1,29 +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;
+"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/test.d.ts

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

package/test.js

@@ -1,19 +1,26 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-const payhos = new index_1.PayHos('<TOKEN_STRING>');
-const sms = payhos.sms;
-const data = {
-    message: 'Hello there, this is a test message from PayHos SDK',
-    recipients: ['+2348166666666', '+2348055555555'],
-    flash: false,
-    senderId: 'PayHos',
-};
-// to send SMS
-sms.send(data).then(response => {
-    // message(s) sent successfully
-    console.log(response);
-}).catch(err => {
-    console.log(err);
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const payhos = new index_1.PayHos('<TOKEN_STRING>');
+const email = payhos.email;
+const data = {
+    subject: 'Test Email',
+    content: `Hey <strong>Alice</strong>, this is a test email message from <a href="https://payhos.com">PayHos API Hub</a>`,
+    customData: {},
+    recipients: [
+        { email: 'example@example.com' },
+        { name: 'Alice', email: 'example2@example.com' }
+    ],
+    from: {
+        name: 'PayHos',
+        email: 'test@test.com'
+    }
+};
+// to send SMS
+email.send(data).then(response => {
+    // message(s) sent successfully
+    console.log(response);
+}).catch(err => {
+    console.log(err);
+});
 //# sourceMappingURL=test.js.map

package/test.js.map

@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;AAAA,mCAAiC;AAGjC,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,gBAAgB,CAAC,CAAC;AAE5C,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;AACvB,MAAM,IAAI,GAAqB;IAC7B,OAAO,EAAE,qDAAqD;IAC9D,UAAU,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAChD,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,QAAQ;CACnB,CAAC;AAEF,cAAc;AACd,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;IAC7B,+BAA+B;IAC/B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;AAAA,mCAAqD;AAErD,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,gBAAgB,CAAC,CAAC;AAE5C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;AAC3B,MAAM,IAAI,GAAuB;IAC/B,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,+GAA+G;IACxH,UAAU,EAAE,EAAE;IACd,UAAU,EAAE;QACV,EAAE,KAAK,EAAE,qBAAqB,EAAE;QAChC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE;KACjD;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,eAAe;KACvB;CACF,CAAC;AAEF,cAAc;AACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;IAC/B,+BAA+B;IAC/B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC,CAAC"}