@payhos/api 2.1.0 → 2.5.0

package/README.md

@@ -4,68 +4,114 @@
 
 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`
+# PayHos API SDK
 
-## Usage
-Create an instance and call available methods from the instance created.
+PayHos provides a small client SDK to interact with the PayHos API for sending email, SMS and requesting prerendered HTML pages.
 
- ```typescript
-import { PayHos } from '@payhos/api';
+## Install
 
-// or
-const { PayHos } = require('@payhos/api');
+```bash
+npm install @payhos/api --save
+```
 
-const payhos = new PayHos('<YOUR API TOKEN>');
+## SMS
 
-// You can access each of PayHos' API features as follows:
-const sms = payhos.sms;
-const email = payhos.email;
- ``` 
+Use the `sms` helper to send messages.
 
-## 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 = {
-  message: 'Hello there, this is a test message from PayHos SDK',
-  recipients: ['+2348166666666', '+2348055555555'],
-  senderId: 'PayHos',
-};
-
-// to send SMS
-sms.send(data).then(response => {
-  // message(s) sent successfully
-  console.log(response);
-}).catch(err => {
-  console.log(err);
+```ts
+import { PayHos } from "@payhos/api";
+const payhos = new PayHos("<YOUR_API_TOKEN>");
+
+await payhos.sms.send({
+  message: "Hello from PayHos",
+  recipients: ["+1234567890"],
+  senderId: "PayHos",
 });
 ```
 
 ## 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: 'alice@example.com' }
-  ],
-  from: {
-    name: 'PayHos',
-    email: 'test@yourdomain.com'
-  }
-};
-
-// to send email
-email.send(data).then(response => {
-  // message(s) sent successfully
-  console.log(response);
-}).catch(err => {
-  console.log(err);
+
+Use the `email` helper to send emails.
+
+```ts
+import { PayHos } from "@payhos/api";
+const payhos = new PayHos("<YOUR_API_TOKEN>");
+
+await payhos.email.send({
+  subject: "Hi",
+  html: "<p>Hello</p>",
+  recipients: [{ email: "user@example.com", name: "Jane" }],
+  sender: { name: "PayHos", email: "noreply@payhos.com" },
+});
+```
+
+## Prerender
+
+Use the `prerender` helper to request a pre-rendered HTML snapshot of a URL.
+
+```ts
+import { PayHos } from "@payhos/api";
+const payhos = new PayHos("<YOUR_API_TOKEN>");
+
+const resp = await payhos.prerender.page({
+  url: "https://example.com",
+  cacheMs: 86400000,
+});
+console.log(resp.data);
+```
+
+## AI
+
+Use the `ai` helper to send prompts to PayHos AI API.
+
+```ts
+import { PayHos } from "@payhos/api";
+const payhos = new PayHos("<YOUR_API_TOKEN>");
+
+const resp = await payhos.ai.prompt({
+  prompt: "Write a short release note for a payments API update.",
+});
+
+if (resp.success && resp.data) {
+  console.log(resp.data.response);
+  console.log(resp.data.usage.totalChars, resp.data.usage.cost);
+}
+```
+
+### AI provider selection
+
+```ts
+const geminiResp = await payhos.ai.prompt({
+  prompt: "Summarize this in 3 bullets",
+  provider: "gemini", // default if omitted
+  model: "gemini-2.0-flash-lite",
+  temperature: 0.6,
+  maxInputChars: 4000,
+  maxOutputChars: 1200,
+});
+
+const gptResp = await payhos.ai.prompt({
+  prompt: "Create a concise onboarding checklist.",
+  provider: "gpt",
+  model: "gpt-4o-mini",
 });
 ```
+
+### AI billing
+
+- Rate: `0.003 USD` per `1000` characters
+- Metering basis: prompt characters + response characters
+- Usage details are returned in `data.usage`
+
+```ts
+// Example usage payload shape
+// {
+//   inputChars: number,
+//   outputChars: number,
+//   totalChars: number,
+//   cost: number,
+//   ratePer1000Chars: number
+// }
+```
+
+For full API details, see https://docs.payhos.com.

package/ai.d.ts

@@ -0,0 +1,6 @@
+import { AIPromptOpts, AIResponse } from './model';
+export declare class AI {
+    private _apiKey;
+    constructor(key: string);
+    prompt(opts: AIPromptOpts): Promise<import("./model").ApiResponse<AIResponse>>;
+}

package/ai.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AI = void 0;
+const api_service_1 = require("./api.service");
+class AI {
+    constructor(key) {
+        this._apiKey = key;
+    }
+    prompt(opts) {
+        return api_service_1.apiHandler.post('ai/prompt', opts, (0, api_service_1.apiHeaders)(this._apiKey));
+    }
+}
+exports.AI = AI;
+//# sourceMappingURL=ai.js.map

package/ai.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.js","sourceRoot":"","sources":["../src/ai.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AAGvD,MAAa,EAAE;IAGb,YAAY,GAAW;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,IAAkB;QAC9B,OAAO,wBAAU,CAAC,IAAI,CAAa,WAAW,EAAE,IAAI,EAAE,IAAA,wBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAClF,CAAC;CACF;AAVD,gBAUC"}

package/api.service.d.ts

@@ -1,4 +1,10 @@
 import { ApiResponse, Map } from './model';
 export declare const apiHandler: {
     post: <T>(path: string, body: Map<any>, headers: Map<any>) => Promise<ApiResponse<T>>;
+    get: <T_1>(path: string, headers: Map<any>) => Promise<ApiResponse<T_1>>;
+};
+export declare const apiHeaders: (apiKey: string) => {
+    Authorization: string;
+    'Content-Type': string;
+    platform: string;
 };

package/api.service.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiHandler = void 0;
+exports.apiHeaders = exports.apiHandler = void 0;
 const axios_1 = require("axios");
 const config_1 = require("./config");
 exports.apiHandler = {
@@ -8,6 +8,19 @@ exports.apiHandler = {
         const url = `${config_1.baseUrl}/v1/api/${path}`;
         const res = await axios_1.default.post(url, body, { headers });
         return res.data;
+    },
+    get: async (path, headers) => {
+        const url = `${config_1.baseUrl}/v1/api/${path}`;
+        const res = await axios_1.default.get(url, { headers });
+        return res.data;
     }
 };
+const apiHeaders = (apiKey) => {
+    return {
+        Authorization: `Bearer ${apiKey}`,
+        'Content-Type': 'application/json',
+        platform: 'web',
+    };
+};
+exports.apiHeaders = apiHeaders;
 //# sourceMappingURL=api.service.js.map

package/api.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.service.js","sourceRoot":"","sources":["../src/api.service.ts"],"names":[],"mappings":";;;AAAA,iCAA0B;AAE1B,qCAAmC;AAEtB,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,KAAK,EAAK,IAAY,EAAE,IAAc,EAAE,OAAiB,EAAE,EAAE;QACjE,MAAM,GAAG,GAAG,GAAG,gBAAO,WAAW,IAAI,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACrD,OAAO,GAAG,CAAC,IAAsB,CAAC;IACpC,CAAC;CACF,CAAA"}
+{"version":3,"file":"api.service.js","sourceRoot":"","sources":["../src/api.service.ts"],"names":[],"mappings":";;;AAAA,iCAA0B;AAE1B,qCAAmC;AAEtB,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,KAAK,EAAK,IAAY,EAAE,IAAc,EAAE,OAAiB,EAAE,EAAE;QACjE,MAAM,GAAG,GAAG,GAAG,gBAAO,WAAW,IAAI,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACrD,OAAO,GAAG,CAAC,IAAsB,CAAC;IACpC,CAAC;IACD,GAAG,EAAE,KAAK,EAAK,IAAY,EAAE,OAAiB,EAAE,EAAE;QAChD,MAAM,GAAG,GAAG,GAAG,gBAAO,WAAW,IAAI,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC,IAAsB,CAAC;IACpC,CAAC;CACF,CAAA;AAEM,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE;IAC3C,OAAO;QACL,aAAa,EAAE,UAAU,MAAM,EAAE;QACjC,cAAc,EAAE,kBAAkB;QAClC,QAAQ,EAAE,KAAK;KAChB,CAAC;AACJ,CAAC,CAAA;AANY,QAAA,UAAU,cAMtB"}

package/config.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.baseUrl = void 0;
+// const platform: string = 'dev';
 const platform = 'prod';
 exports.baseUrl = 'a';
 if (platform === 'dev') {

package/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA,MAAM,QAAQ,GAAW,MAAM,CAAC;AAErB,QAAA,OAAO,GAAG,GAAG,CAAC;AAEzB,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;IACvB,eAAO,GAAG,uBAAuB,CAAC;AACpC,CAAC;KAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;IAC/B,eAAO,GAAG,kCAAkC,CAAC;AAC/C,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,MAAM,QAAQ,GAAW,MAAM,CAAC;AAErB,QAAA,OAAO,GAAG,GAAG,CAAC;AAEzB,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;IACvB,eAAO,GAAG,uBAAuB,CAAC;AACpC,CAAC;KAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;IAC/B,eAAO,GAAG,kCAAkC,CAAC;AAC/C,CAAC"}

package/email.d.ts

@@ -2,7 +2,6 @@ import { EmailOpts } from './model';
 export declare class Email {
     private _apiKey;
     constructor(key: string);
-    private headers;
     sendEmail(opts: EmailOpts): Promise<import("./model").ApiResponse<any>>;
     sendEmails(opts: EmailOpts[]): Promise<import("./model").ApiResponse<any>>;
 }

package/email.js

@@ -6,17 +6,11 @@ class Email {
     constructor(key) {
         this._apiKey = key;
     }
-    headers() {
-        return {
-            Authorization: `Bearer ${this._apiKey}`,
-            'Content-Type': 'application/json',
-        };
-    }
     sendEmail(opts) {
         return this.sendEmails([opts]);
     }
     sendEmails(opts) {
-        return api_service_1.apiHandler.post('emails/send', opts, this.headers());
+        return api_service_1.apiHandler.post('emails/send', opts, (0, api_service_1.apiHeaders)(this._apiKey));
     }
 }
 exports.Email = Email;

package/email.js.map

@@ -1 +1 @@
-{"version":3,"file":"email.js","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAG3C,MAAa,KAAK;IAGhB,YAAY,GAAW;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAEO,OAAO;QACb,OAAO;YACL,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,EAAE;YACvC,cAAc,EAAE,kBAAkB;SACnC,CAAC;IACJ,CAAC;IAEM,SAAS,CAAC,IAAe;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IAEM,UAAU,CAAC,IAAiB;QACjC,OAAO,wBAAU,CAAC,IAAI,CAAM,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AArBD,sBAqBC"}
+{"version":3,"file":"email.js","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AAGvD,MAAa,KAAK;IAGhB,YAAY,GAAW;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAEM,SAAS,CAAC,IAAe;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IAEM,UAAU,CAAC,IAAiB;QACjC,OAAO,wBAAU,CAAC,IAAI,CAAM,aAAa,EAAE,IAAI,EAAE,IAAA,wBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7E,CAAC;CACF;AAdD,sBAcC"}

package/index.d.ts

@@ -1,8 +1,12 @@
 import { Email } from './email';
+import { PreRender } from './prerender';
 import { SMS } from './sms';
+import { AI } from './ai';
 export * from './model';
 export declare class PayHos {
     sms: SMS;
     email: Email;
+    prerender: PreRender;
+    ai: AI;
     constructor(key: string);
 }

package/index.js

@@ -3,12 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PayHos = void 0;
 const tslib_1 = require("tslib");
 const email_1 = require("./email");
+const prerender_1 = require("./prerender");
 const sms_1 = require("./sms");
+const ai_1 = require("./ai");
 tslib_1.__exportStar(require("./model"), exports);
 class PayHos {
     constructor(key) {
         this.sms = new sms_1.SMS(key);
         this.email = new email_1.Email(key);
+        this.prerender = new prerender_1.PreRender(key);
+        this.ai = new ai_1.AI(key);
     }
 }
 exports.PayHos = PayHos;

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAAgC;AAChC,+BAA4B;AAE5B,kDAAwB;AAExB,MAAa,MAAM;IAIjB,YAAY,GAAW;QACrB,IAAI,CAAC,GAAG,GAAG,IAAI,SAAG,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF;AARD,wBAQC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAAgC;AAChC,2CAAwC;AACxC,+BAA4B;AAC5B,6BAA0B;AAE1B,kDAAwB;AAExB,MAAa,MAAM;IAMjB,YAAY,GAAW;QACrB,IAAI,CAAC,GAAG,GAAG,IAAI,SAAG,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,EAAE,GAAG,IAAI,OAAE,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;CACF;AAZD,wBAYC"}

package/model.d.ts

@@ -25,3 +25,28 @@ export interface SMSOpts {
     message: string;
     senderId: string;
 }
+export interface PreRenderOpts {
+    url: string;
+    cacheMs?: number;
+}
+export interface AIPromptOpts {
+    prompt: string;
+    provider?: 'gemini' | 'gpt';
+    model?: string;
+    temperature?: number;
+    maxOutputChars?: number;
+    maxInputChars?: number;
+}
+export interface AIResponse {
+    id: number;
+    provider: 'gemini' | 'gpt';
+    model: string;
+    response: string;
+    usage: {
+        inputChars: number;
+        outputChars: number;
+        totalChars: number;
+        cost: number;
+        ratePer1000Chars: number;
+    };
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@payhos/api",
   "description": "An API package for payhos's API built for JavaScript and Typescript developers",
-  "version": "2.1.0",
+  "version": "2.5.0",
   "main": "index.js",
   "typings": "index.d.ts",
   "scripts": {
     "test": "mocha --require ts-node/register test/**/*.ts",
     "deploy": "node copy-models && tsc && node copy-assets && cd dist && npm publish --access=public",
-    "unpublish": "npm unpublish @payhos/api@0.8.14"
+    "unpublish": "npm unpublish @payhos/api@2.3.0"
   },
   "dependencies": {
     "axios": "^1.3.5"

package/prerender.d.ts

@@ -0,0 +1,6 @@
+import { PreRenderOpts } from './model';
+export declare class PreRender {
+    private _apiKey;
+    constructor(key: string);
+    page(opts: PreRenderOpts): Promise<import("./model").ApiResponse<string>>;
+}

package/prerender.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreRender = void 0;
+const api_service_1 = require("./api.service");
+class PreRender {
+    constructor(key) {
+        this._apiKey = key;
+    }
+    page(opts) {
+        const path = `prerender?url=${encodeURIComponent(opts.url)}&cacheMs=${opts.cacheMs || 86400000 * 3}`;
+        return api_service_1.apiHandler.get(path, (0, api_service_1.apiHeaders)(this._apiKey));
+    }
+}
+exports.PreRender = PreRender;
+//# sourceMappingURL=prerender.js.map

package/prerender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prerender.js","sourceRoot":"","sources":["../src/prerender.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AAGvD,MAAa,SAAS;IAGpB,YAAY,GAAW;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAEM,IAAI,CAAC,IAAmB;QAC7B,MAAM,IAAI,GAAG,iBAAiB,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,OAAO,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACrG,OAAO,wBAAU,CAAC,GAAG,CAAS,IAAI,EAAE,IAAA,wBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,CAAC;CACF;AAXD,8BAWC"}

package/sms.d.ts

@@ -2,6 +2,5 @@ import { SMSOpts } from './model';
 export declare class SMS {
     private _apiKey;
     constructor(key: string);
-    private headers;
     sendSMS<T>(opts: SMSOpts[]): Promise<import("./model").ApiResponse<T>>;
 }

package/sms.js

@@ -6,14 +6,8 @@ class SMS {
     constructor(key) {
         this._apiKey = key;
     }
-    headers() {
-        return {
-            Authorization: `Bearer ${this._apiKey}`,
-            'Content-Type': 'application/json',
-        };
-    }
     sendSMS(opts) {
-        return api_service_1.apiHandler.post('sms/send', opts, this.headers());
+        return api_service_1.apiHandler.post('sms/send', opts, (0, api_service_1.apiHeaders)(this._apiKey));
     }
 }
 exports.SMS = SMS;

package/sms.js.map

@@ -1 +1 @@
-{"version":3,"file":"sms.js","sourceRoot":"","sources":["../src/sms.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAG3C,MAAa,GAAG;IAGd,YAAY,GAAW;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAEO,OAAO;QACb,OAAO;YACL,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,EAAE;YACvC,cAAc,EAAE,kBAAkB;SACnC,CAAC;IACJ,CAAC;IAEM,OAAO,CAAI,IAAe;QAC/B,OAAO,wBAAU,CAAC,IAAI,CAAI,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AAjBD,kBAiBC"}
+{"version":3,"file":"sms.js","sourceRoot":"","sources":["../src/sms.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AAGvD,MAAa,GAAG;IAGd,YAAY,GAAW;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAEM,OAAO,CAAI,IAAe;QAC/B,OAAO,wBAAU,CAAC,IAAI,CAAI,UAAU,EAAE,IAAI,EAAE,IAAA,wBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AAVD,kBAUC"}