paperless-client 1.0.1 → 1.0.2

package/dist/check_payment.js

@@ -1,7 +1,10 @@
 import { parseBody } from "./lib.js";
 export async function checkPayment(origin, muid, token) {
     try {
-        const response = await fetch(`${origin}/api/v1/gateway/check-payment?muid=${muid}&token=${token}`);
+        const url = new URL(`${origin}/api/v1/gateway/check-payment`);
+        url.searchParams.append('muid', muid);
+        url.searchParams.append('token', token);
+        const response = await fetch(url, { method: 'POST' });
         if (!response.ok)
             return { success: false, data: await parseBody(response) };
         const data = await parseBody(response, true);

package/dist/index.d.ts

@@ -5,9 +5,25 @@ export { type CallbackDataType } from './callback_data.ts';
 export type GetPaymentUrlOptionsType = Omit<InitiatePaymentOptionsType, 'muid' | 'access_app_key'>;
 export default class PaperlessClient {
     #private;
+    /**
+     * @param muid It will be provided upon registration
+     * @param app_access_key It will be provided upon registration
+     * @param host The origin of the server
+     */
     constructor(muid: string, app_access_key: string, host: string);
-    getPaymentUrl(options: GetPaymentUrlOptionsType): Promise<string>;
-    checkPaymentStatus(token: string): Promise<{
+    /**
+     * merchant_order_id and merchant_ref_id should be unique for each payment.
+     * marchant_order_id is the order id is used by Peperless to identify the order. Max 20 characters.
+     * merchant_ref_id is used by the merchant to identify the order in the dashboard.
+     */
+    newPayment(options: GetPaymentUrlOptionsType): Promise<{
+        url: string;
+        token: string;
+    }>;
+    /**
+     * @param token The token received from the newPayment method
+     */
+    checkPayment(token: string): Promise<{
         muid: string;
         ref_id: string;
         token: string;

package/dist/index.js

@@ -9,12 +9,22 @@ export default class PaperlessClient {
     #muid;
     #app_access_key;
     #host;
+    /**
+     * @param muid It will be provided upon registration
+     * @param app_access_key It will be provided upon registration
+     * @param host The origin of the server
+     */
     constructor(muid, app_access_key, host) {
         this.#muid = muid;
         this.#app_access_key = app_access_key;
         this.#host = host;
     }
-    async getPaymentUrl(options) {
+    /**
+     * merchant_order_id and merchant_ref_id should be unique for each payment.
+     * marchant_order_id is the order id is used by Peperless to identify the order. Max 20 characters.
+     * merchant_ref_id is used by the merchant to identify the order in the dashboard.
+     */
+    async newPayment(options) {
         const checkServerResponse = await checkServer(this.#host);
         if (!checkServerResponse.success) {
             throw new Error('Server check failed', {
@@ -31,9 +41,15 @@ export default class PaperlessClient {
                 cause: initiatePaymentResponse.data
             });
         }
-        return gatewayUrl(initiatePaymentResponse.data.token, checkServerResponse.data.gateway_url);
+        return {
+            url: gatewayUrl(initiatePaymentResponse.data.token, checkServerResponse.data.gateway_url),
+            token: initiatePaymentResponse.data.token
+        };
     }
-    async checkPaymentStatus(token) {
+    /**
+     * @param token The token received from the newPayment method
+     */
+    async checkPayment(token) {
         const checkPaymentResponse = await checkPayment(this.#host, this.#muid, token);
         if (!checkPaymentResponse.success) {
             throw new Error('Payment check failed', {

package/dist/initiate_payment.js

@@ -4,7 +4,7 @@ export async function initiatePayment(url, options) {
         const requestUrl = new URL(url);
         for (const key in options) {
             const value = options[key];
-            if (!value)
+            if (value === undefined)
                 continue;
             requestUrl.searchParams.append(key, value);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paperless-client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A client for interacting with the Paperless payment API.",
   "author": "Rifat Mahmud",
   "license": "MIT",