coffee-pay-sdk 1.0.1 → 1.0.3

package/README.md

@@ -11,6 +11,7 @@ Node.js SDK to integrate with the **COFFEE-PAY** payment gateway easily and secu
 
 - 🔐 **Automatic JWT Authentication**: Handles `apiKey` and `apiSecret` encryption automatically.
 - 🧾 **Subscription Management**: Full CRUD support for subscription plans.
+- 💳 **Payment Methods**: Consult available payment methods.
 - 🛡️ **Web Signing Utilities**: Easy signature generation for secure web payment buttons.
 - 🧠 **Fully Typed**: Built with TypeScript for excellent developer experience.
 - ⚙️ **Modern**: Compatible with Node.js v18+.
@@ -84,7 +85,17 @@ const currencies = await coffee.currencies.list(10, 1);
 const currency = await coffee.currencies.get('CURRENCY_ID');
 ```
 
-### 4. Signing for Web Payments
+### 4. Consult Payment Methods
+
+```typescript
+// List available payment methods
+const methods = await coffee.paymentMethods.list(10, 1);
+
+// Get payment method by ID
+const method = await coffee.paymentMethods.get('METHOD_ID');
+```
+
+### 5. Signing for Web Payments
 
 Use this utility to sign requests made from the browser (e.g., for payment buttons).
 
@@ -128,6 +139,13 @@ const signature = CryptoUtils.generateWebSignature(accountKey, integrityKey, tim
 | `list(limit, page)` | Returns a list of supported currencies. |
 | `get(id)` | Retrieves detailed information for a specific currency. |
 
+### `paymentMethods`
+
+| Method | Description |
+| --- | --- |
+| `list(limit, page)` | Returns a list of available payment methods. |
+| `get(id)` | Retrieves detailed information for a specific payment method. |
+
 ---
 
 ## 🤝 Contributing

package/dist/client.d.ts

@@ -1,10 +1,12 @@
 import { CoffeeConfig } from './types';
 import { SubscriptionsPlans } from './resources/subscriptions-plans';
 import { Currencies } from './resources/currencies';
+import { PaymentMethods } from './resources/payment-methods';
 export declare class CoffeeSDK {
     private axiosInstance;
     private config;
     subscriptionsPlans: SubscriptionsPlans;
     currencies: Currencies;
+    paymentMethods: PaymentMethods;
     constructor(config: CoffeeConfig);
 }

package/dist/client.js

@@ -8,11 +8,13 @@ const axios_1 = __importDefault(require("axios"));
 const auth_1 = require("./utils/auth");
 const subscriptions_plans_1 = require("./resources/subscriptions-plans");
 const currencies_1 = require("./resources/currencies");
+const payment_methods_1 = require("./resources/payment-methods");
 class CoffeeSDK {
     axiosInstance;
     config;
     subscriptionsPlans;
     currencies;
+    paymentMethods;
     constructor(config) {
         this.config = config;
         this.axiosInstance = axios_1.default.create({
@@ -27,6 +29,7 @@ class CoffeeSDK {
         });
         this.subscriptionsPlans = new subscriptions_plans_1.SubscriptionsPlans(this.axiosInstance);
         this.currencies = new currencies_1.Currencies(this.axiosInstance);
+        this.paymentMethods = new payment_methods_1.PaymentMethods(this.axiosInstance);
     }
 }
 exports.CoffeeSDK = CoffeeSDK;

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './types';
 export { CryptoUtils } from './utils/crypto';
 export { AuthUtils } from './utils/auth';
 export { Currencies } from './resources/currencies';
+export { PaymentMethods } from './resources/payment-methods';

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Currencies = exports.AuthUtils = exports.CryptoUtils = void 0;
+exports.PaymentMethods = exports.Currencies = exports.AuthUtils = exports.CryptoUtils = void 0;
 __exportStar(require("./client"), exports);
 __exportStar(require("./types"), exports);
 var crypto_1 = require("./utils/crypto");
@@ -23,3 +23,5 @@ var auth_1 = require("./utils/auth");
 Object.defineProperty(exports, "AuthUtils", { enumerable: true, get: function () { return auth_1.AuthUtils; } });
 var currencies_1 = require("./resources/currencies");
 Object.defineProperty(exports, "Currencies", { enumerable: true, get: function () { return currencies_1.Currencies; } });
+var payment_methods_1 = require("./resources/payment-methods");
+Object.defineProperty(exports, "PaymentMethods", { enumerable: true, get: function () { return payment_methods_1.PaymentMethods; } });

package/dist/resources/payment-methods.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+import { ApiResponse, PaymentMethod, ListResponse } from '../types';
+export declare class PaymentMethods {
+    private axios;
+    constructor(axios: AxiosInstance);
+    /**
+     * Retrieves a list of available payment methods.
+     * @param limit Number of items to retrieve (default: 100)
+     * @param page Page number (default: 1)
+     */
+    list(limit?: number, page?: number): Promise<ListResponse<PaymentMethod>>;
+    /**
+     * Retrieves a payment method by ID.
+     */
+    get(id: string): Promise<ApiResponse<PaymentMethod>>;
+}

package/dist/resources/payment-methods.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentMethods = void 0;
+class PaymentMethods {
+    axios;
+    constructor(axios) {
+        this.axios = axios;
+    }
+    /**
+     * Retrieves a list of available payment methods.
+     * @param limit Number of items to retrieve (default: 100)
+     * @param page Page number (default: 1)
+     */
+    async list(limit = 100, page = 1) {
+        const response = await this.axios.get('/payments-methods', {
+            params: { limit, page },
+        });
+        return response.data;
+    }
+    /**
+     * Retrieves a payment method by ID.
+     */
+    async get(id) {
+        const response = await this.axios.get(`/payments-methods/${id}`);
+        return response.data;
+    }
+}
+exports.PaymentMethods = PaymentMethods;

package/dist/resources/subscriptions-plans.js

@@ -21,7 +21,10 @@ class SubscriptionsPlans {
      * Creates a new subscription plan.
      */
     async create(data) {
-        const response = await this.axios.post('/subscriptions-plans', data);
+        const response = await this.axios.post('/subscriptions-plans', {
+            ...data,
+            source: 'API',
+        });
         return response.data;
     }
     /**

package/dist/types/index.d.ts

@@ -50,19 +50,18 @@ export interface ListResponse<T> {
 }
 export interface CreateSubscriptionPlanDto {
     name: string;
+    reference: string;
     description: string;
     price: number;
     currencyId: string;
-    interval: 'daily' | 'weekly' | 'monthly' | 'yearly';
+    interval: 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'yearly';
+    intervalCount: number;
     billingDay: number;
     freeDays: number;
+    allowProrate: boolean;
     status: boolean;
-    source: string;
-    intervalCount?: number;
-    reference?: string;
-    allowProrate?: boolean;
-    redirectUrl?: string;
-    urlBack?: string;
+    redirectUrl: string;
+    urlBack: string;
 }
 export type UpdateSubscriptionPlanDto = Partial<CreateSubscriptionPlanDto>;
 export interface Currency {
@@ -79,3 +78,15 @@ export interface Currency {
     createdAt: string;
     updatedAt: string;
 }
+export interface PaymentMethod {
+    id: string;
+    name: string;
+    slug: string;
+    icon?: string;
+    status: boolean;
+    isDeleted: boolean;
+    createdBy: string;
+    updatedBy: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coffee-pay-sdk",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Node.js SDK for Coffee-Pay payment gateway",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",