paystack-sdk 2.3.1 → 2.4.1

package/dist/paystack.d.ts

@@ -6,6 +6,7 @@ import { Invoice } from './invoice/invoice';
 import { PaymentPage } from './payment/payment';
 import { Plan } from './plan';
 import { Product } from './product/product';
+import { Recipient } from './recipient/recipient';
 import { Settlement } from './settlement/settlement';
 import { TransactionSplit } from './split/split';
 import { SubAccount } from './subaccounts/subaccount';
@@ -33,5 +34,6 @@ export declare class Paystack {
     page: PaymentPage;
     invoice: Invoice;
     settlement: Settlement;
+    recipient: Recipient;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -10,6 +10,7 @@ const invoice_1 = require("./invoice/invoice");
 const payment_1 = require("./payment/payment");
 const plan_1 = require("./plan");
 const product_1 = require("./product/product");
+const recipient_1 = require("./recipient/recipient");
 const settlement_1 = require("./settlement/settlement");
 const split_1 = require("./split/split");
 const subaccount_1 = require("./subaccounts/subaccount");
@@ -45,6 +46,7 @@ class Paystack {
         this.page = new payment_1.PaymentPage(this.http);
         this.invoice = new invoice_1.Invoice(this.http);
         this.settlement = new settlement_1.Settlement(this.http);
+        this.recipient = new recipient_1.Recipient(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/recipient/interface.d.ts

@@ -0,0 +1,73 @@
+import { Meta, Response } from '../interface';
+export interface CreateRecipient {
+    /**
+     * Recipient Type.
+     * It could be one of: `nuban`, `mobile_money` or `basa`
+     */
+    type: string;
+    /** A name for the recipient */
+    name: string;
+    /** Required if type is `nuban` or `basa` */
+    account_number: string;
+    /**
+     * Required if type is nuban or basa.
+     * You can get the list of Bank Codes by calling the List Banks endpoint.
+     */
+    bank_code: string;
+    /** A description for this recipient */
+    description?: string;
+    /** Currency for the account receiving the transfer */
+    currency?: string;
+    /** An authorization code from a previous transaction */
+    authorization_code?: string;
+    /**
+     * Store additional information about your
+     * recipient in a structured format, JSON
+     */
+    metadata?: Record<string, unknown>;
+}
+export interface UpdateRecipient {
+    name: string;
+    email?: string;
+}
+export interface Recipient {
+    id: number;
+    active: boolean;
+    createdAt: Date;
+    currency: string;
+    description?: string;
+    domain: string;
+    email?: string;
+    integration: number;
+    metadata?: Record<string, unknown>;
+    name: string;
+    recipient_code: string;
+    type: string;
+    updatedAt: Date;
+    is_deleted: boolean;
+    isDeleted: boolean;
+    details: RecipientDetails;
+}
+export interface RecipientDetails {
+    authorization_code?: string;
+    account_number: string;
+    account_name: string;
+    bank_code: string;
+    bank_name: string;
+}
+export interface ViewRecipientResponse extends Response {
+    data: Recipient;
+}
+export interface RecipientCreatedResponse extends Response {
+    data: Recipient;
+}
+export interface BulkRecipientsCreatedResponse extends Response {
+    data: {
+        success: Recipient[];
+        errors: Record<string, unknown>[];
+    };
+}
+export interface ListRecipientResponse extends Response {
+    data: Recipient[];
+    meta: Meta;
+}

package/dist/recipient/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/recipient/recipient.d.ts

@@ -0,0 +1,12 @@
+import { Axios } from 'axios';
+import { BadRequest, QueryParams, Response } from '../interface';
+import { CreateRecipient, ListRecipientResponse, RecipientCreatedResponse, UpdateRecipient, ViewRecipientResponse } from './interface';
+export declare class Recipient {
+    private http;
+    constructor(http: Axios);
+    create(data: CreateRecipient | CreateRecipient[], isBulk?: boolean): Promise<RecipientCreatedResponse | BadRequest>;
+    list(queryParams?: QueryParams): Promise<ListRecipientResponse | BadRequest>;
+    fetch(id: string): Promise<ViewRecipientResponse | BadRequest>;
+    update(id: string, data: UpdateRecipient): Promise<ViewRecipientResponse | BadRequest>;
+    delete(id: string): Promise<Response | BadRequest>;
+}

package/dist/recipient/recipient.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Recipient = void 0;
+class Recipient {
+    constructor(http) {
+        this.http = http;
+    }
+    create(data, isBulk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let body;
+            let url = '/transferrecipient';
+            body = data;
+            if (isBulk)
+                url += '/bulk';
+            if (isBulk)
+                body = { batch: data };
+            return yield this.http.post(url, JSON.stringify(body));
+        });
+    }
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/transferrecipient', {
+                params: Object.assign({}, queryParams),
+            });
+        });
+    }
+    fetch(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/transferrecipient/${id}`);
+        });
+    }
+    update(id, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.put(`/transferrecipient/${id}`, JSON.stringify(data));
+        });
+    }
+    delete(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.delete(`/transferrecipient/${id}`);
+        });
+    }
+}
+exports.Recipient = Recipient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "2.3.1",
+  "version": "2.4.1",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Tech Priest",