paystack-sdk 3.4.1 → 3.6.0

package/README.md

@@ -21,6 +21,8 @@ For Typescript
 
 ```typescript
 import {Paystack} from 'paystack-sdk';
+// or
+import Paystack from 'paystack-sdk';
 
 const paystack = new Paystack("secret_key");
 ```
@@ -29,6 +31,9 @@ For Javscript
 
 ```javascript
 const Paystack = require('paystack-sdk').Paystack;
+// or
+const Paystack = require('paystack-sdk');
+
 const paystack = new Paystack('secret_key');
 ```
 
@@ -56,14 +61,20 @@ All methods use promise meaning you can either use the `async...await` or `then.
 - [x] Transaction Splits
 - [x] Settlements
 - [x] Invoices
-- [x] Transaction Recipients
+- [x] Transfer Recipients
 - [x] Transfers Control
 - [x] Bulk Charges
-- [ ] Control Panel
-- [ ] Disputes
 - [x] Refunds
 - [x] Verification
 - [x] Miscellaneous
+- [ ] Disputes
+- [ ] Control Panel
+- [ ] Terminal
+- [ ] Virtual Terminal
+- [ ] Direct Debit
+- [ ] Payment Pages
+- [ ] Payment Requests
+- [ ] Integration
 
 ## CONTRIBUTING
 

package/dist/paystack.d.ts

@@ -21,6 +21,12 @@ import { Misc } from './misc/misc';
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
  */
+/**
+ * @deprecated This named export is deprecated and will be removed
+ * in version `4.0.0`.
+ * Use the default export instead:
+ * Use `import Paystack from 'paystack-sdk'`
+ */
 export declare class Paystack {
     private readonly key;
     private readonly http;

package/dist/paystack.js

@@ -28,6 +28,12 @@ const axios_1 = __importDefault(require("axios"));
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
  */
+/**
+ * @deprecated This named export is deprecated and will be removed
+ * in version `4.0.0`.
+ * Use the default export instead:
+ * Use `import Paystack from 'paystack-sdk'`
+ */
 class Paystack {
     constructor(key) {
         this.key = key;

package/dist/refund/interface.d.ts

@@ -1,6 +1,7 @@
+import { Customer } from '../customer/interface';
 import { Currency, QueryParams, Response } from '../interface';
 import { Transaction } from '../transaction/interface';
-export interface CreateRefund {
+export type CreateRefund = {
     /**
      * Transaction reference or id
      */
@@ -23,26 +24,43 @@ export interface CreateRefund {
      * Merchant reason
      */
     merchant_note?: string;
-}
-export interface ListRefundQueryParams extends QueryParams {
+};
+export type ListRefundQueryParams = QueryParams & {
     /**
-     * Identifier for transaction to be refunded
+     * Any of the [supported currency](https://paystack.com/docs/api/#supported-currency)
      */
-    reference: string;
+    currency: Currency;
     /**
-     * Any of the supported currency
+     * The transaction ID of the refunded transaction
      */
-    currency: Currency;
-}
-export interface ListRefundsResponse extends Response {
+    transaction: string;
+};
+export type RetryAccountDetails = {
+    /**
+     * The currency of the customer's bank account. It should be the same as the currency the payment was made
+     */
+    currency: string;
+    /**
+     * The customer's account number
+     */
+    account_number: string;
+    /**
+     * The ID representing the customer's bank. You can get the list of bank IDs by calling the List Banks endpoint.
+     */
+    bank_id: string;
+};
+export type ListRefundsResponse = Response & {
     data: Refund[];
-}
-export interface RefundCreatedResponse extends Response {
+};
+export type RefundCreatedResponse = Response & {
     data: Refund;
-}
-export interface FetchRefundResponse extends Response {
+};
+export type FetchRefundResponse = Response & {
     data: Refund;
-}
+};
+export type RetryRefundResponse = Response & {
+    data: Refund;
+};
 export interface Refund {
     id: number;
     integration: number;
@@ -55,12 +73,18 @@ export interface Refund {
     channel: string;
     fully_deducted: boolean;
     refunded_by: string;
-    refunded_at?: string;
-    expected_at: string;
+    refunded_at?: Date;
+    expected_at: Date;
     settlement: number;
     customer_note: string;
     merchant_note: string;
-    createdAt: string;
-    updatedAt: string;
-    status: string;
+    createdAt: Date;
+    updatedAt: Date;
+    status: 'pending' | 'processing' | 'needs-attention';
+    bank_reference?: string;
+    reason: string;
+    customer?: Customer;
+    initiated_at: string;
+    reversed_at?: Date;
+    session_id?: string;
 }

package/dist/refund/refund.d.ts

@@ -1,22 +1,20 @@
 import { Axios } from 'axios';
-import { FetchRefundResponse, CreateRefund, ListRefundQueryParams, ListRefundsResponse, RefundCreatedResponse } from './interface';
+import { FetchRefundResponse, CreateRefund, ListRefundQueryParams, ListRefundsResponse, RefundCreatedResponse, RetryRefundResponse, RetryAccountDetails } from './interface';
 import { BadRequest } from '../interface';
 export declare class Refund {
     private http;
     constructor(http: Axios);
     /**
-     * #### Create Refund
      * Initiate a refund on your integration
      */
     create(data: CreateRefund): Promise<RefundCreatedResponse | BadRequest>;
     /**
-     * #### List Refunds
      * List refunds available on your integration
      */
     list(queryParams?: ListRefundQueryParams): Promise<ListRefundsResponse | BadRequest>;
     /**
-     * #### Fetch Refund
      * Get details of a refund on your integration
      */
-    fetch(reference: string): Promise<FetchRefundResponse | BadRequest>;
+    fetch(id: number): Promise<FetchRefundResponse | BadRequest>;
+    retry(id: number, data: RetryAccountDetails): Promise<RetryRefundResponse | BadRequest>;
 }

package/dist/refund/refund.js

@@ -6,14 +6,12 @@ class Refund {
         this.http = http;
     }
     /**
-     * #### Create Refund
      * Initiate a refund on your integration
      */
     async create(data) {
         return await this.http.post('/refund', JSON.stringify(data));
     }
     /**
-     * #### List Refunds
      * List refunds available on your integration
      */
     async list(queryParams) {
@@ -22,11 +20,15 @@ class Refund {
         });
     }
     /**
-     * #### Fetch Refund
      * Get details of a refund on your integration
      */
-    async fetch(reference) {
-        return await this.http.get(`/refund/${reference}`);
+    async fetch(id) {
+        return await this.http.get(`/refund/${id}`);
+    }
+    async retry(id, data) {
+        return await this.http.post(`/refund/retry_with_customer_details/${id}`, {
+            refund_account_details: data,
+        });
     }
 }
 exports.Refund = Refund;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "3.4.1",
+  "version": "3.6.0",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Tech Priest",
@@ -12,8 +12,7 @@
     "lint": "eslint . --ext .ts",
     "prepare": "npm run build",
     "prepublishOnly": "npm run lint",
-    "preversion": "npm run lint",
-    "version": "npm run format && git add -A src",
+    "preversion": "npm run format && npm run lint && git add -A src",
     "postversion": "git push && git push --tags",
     "test": "jest"
   },
@@ -41,7 +40,9 @@
     "Paystack",
     "Typescript",
     "payment",
-    "node"
+    "node",
+    "API",
+    "naira"
   ],
   "repository": {
     "type": "git",