paystack-sdk 1.2.0 → 2.1.0

package/README.md

@@ -16,7 +16,7 @@ For NPM
 
 For Typescript
 
-```
+```typescript
 import {Paystack} from 'paystack-sdk';
 
 const paystack = new Paystack("secret_key);
@@ -24,7 +24,7 @@ const paystack = new Paystack("secret_key);
 
 For Javscript
 
-```
+```javascript
 const Paystack = require('paystack-sdk').Paystack;
 const paystack = new Paystack("secret_key");
 ```
@@ -41,3 +41,10 @@ All methods use promise meaning you can either use the `async...await` or `then.
 - Transaction
 - Transfer
 - dedicated (For dedicated accounts)
+
+
+## CONTRIBUTING
+If you notice a missing function, or maybe a bug. Please feel free to submit
+a PR. I will take a look at it.
+You will need to fork the repo and create a PR against it with your changes.
+Thank you :heart:

package/dist/customer/interface.d.ts

@@ -1,13 +1,13 @@
 import { Authorization } from '../charge';
 import { Meta } from '../interface';
 import { Subscription } from '../subscription/interface';
-import { TransactionData } from '../transaction';
+import { Transaction } from '../transaction';
 export interface CreateCustomer {
     email: string;
     first_name: string;
     last_name: string;
     phone?: string;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 }
 export interface Response {
     status: boolean;
@@ -15,14 +15,14 @@ export interface Response {
 }
 export interface CustomerCreated extends Response {
     data: {
-        transactions: TransactionData[];
+        transactions: Transaction[];
         subscriptions: Subscription[];
         authorizations: Authorization[];
         first_name: string;
         last_name: string;
         email: string;
         phone: string | null;
-        metadata: Record<string, any> | null;
+        metadata?: Record<string, unknown>;
         domain: string;
         customer_code: string;
         risk_action: string;
@@ -48,7 +48,7 @@ export interface CustomerData extends Response {
         domain: string;
         customer_code: string;
         id: string;
-        transactions: TransactionData[];
+        transactions: Transaction[];
         subscriptions: Subscription[];
         authorizations: Authorization[];
         createdAt: Date;
@@ -206,7 +206,7 @@ export interface ICustomer {
     domain: string;
     customer_code: string;
     id: string;
-    transactions: TransactionData[];
+    transactions: Transaction[];
     subscriptions: Subscription[];
     authorizations: Authorization[];
     createdAt: Date;

package/dist/dedicated/interface.d.ts

@@ -1,7 +1,7 @@
 import { Authorization, Customer } from '../charge';
 import { Meta } from '../interface';
 import { Subscription } from '../subscription';
-import { Response, TransactionData } from '../transaction';
+import { Response, Transaction } from '../transaction';
 export interface DedicatedAccountData {
     id: number;
     account_name: string;
@@ -49,7 +49,7 @@ export interface DedicatedAccountCreatedResponse extends Response {
 }
 export interface FetchDedicatedVirtualAccountResponse extends Response {
     data: {
-        transactions: TransactionData[];
+        transactions: Transaction[];
         subscriptions: Subscription[];
         authorizations: Authorization[];
         first_name: string;

package/dist/paystack.d.ts

@@ -3,6 +3,7 @@ import { Customer } from './customer';
 import { DedicatedAccount } from './dedicated/dedicated';
 import { Plan } from './plan';
 import { Product } from './product/product';
+import { TransactionSplit } from './split/split';
 import { Subscription } from './subscription/subscription';
 import { Transaction } from './transaction';
 import { Transfer } from './transfer/transfer';
@@ -21,5 +22,6 @@ export declare class Paystack {
     subscription: Subscription;
     transaction: Transaction;
     transfer: Transfer;
+    split: TransactionSplit;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -7,6 +7,7 @@ const customer_1 = require("./customer");
 const dedicated_1 = require("./dedicated/dedicated");
 const plan_1 = require("./plan");
 const product_1 = require("./product/product");
+const split_1 = require("./split/split");
 const subscription_1 = require("./subscription/subscription");
 const transaction_1 = require("./transaction");
 const transfer_1 = require("./transfer/transfer");
@@ -25,6 +26,9 @@ class Paystack {
             },
         });
         this.http.interceptors.response.use((response) => (response.data = JSON.parse(response.data)));
+        // this.http.interceptors.request.use(
+        //   (body) => (body.data = JSON.stringify(body.data)),
+        // );
         this.charge = new charge_1.Charge(this.http);
         this.customer = new customer_1.Customer(this.http);
         this.plan = new plan_1.Plan(this.http);
@@ -33,6 +37,7 @@ class Paystack {
         this.transaction = new transaction_1.Transaction(this.http);
         this.transfer = new transfer_1.Transfer(this.http);
         this.dedicated = new dedicated_1.DedicatedAccount(this.http);
+        this.split = new split_1.TransactionSplit(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/split/index.js

@@ -0,0 +1 @@
+"use strict";

package/dist/split/interface.d.ts

@@ -0,0 +1,130 @@
+import { Meta } from '../interface';
+export declare type SplitCurrrencyType = 'GHS' | 'NGN' | 'ZAR' | 'USD';
+export declare type SplitType = 'percentage' | 'flat';
+export interface BadRequest {
+    status: boolean;
+    message: string;
+    data: null;
+}
+interface SubAccount {
+    id: number;
+    subaccount_code: string;
+    business_name: string;
+    description: string;
+    primary_contact_name?: string;
+    primary_contact_email?: string;
+    primary_contact_phone?: string;
+    metadata?: Record<string, unknown>;
+    percentage_charge?: number;
+    settlement_bank?: string;
+    account_number?: string;
+}
+export interface SplitSubAccount {
+    /**
+     * This is the sub account code
+     */
+    subaccount: string;
+    share: number;
+}
+export interface CreateSplit {
+    /**
+     * Name of the transaction split
+     */
+    name: string;
+    /**
+     * The type of transaction split you want to create.
+     * You can use one of the following: percentage | flat
+     */
+    type: SplitType;
+    /**
+     * Any of NGN, GHS, ZAR, or USD
+     */
+    currency: SplitCurrrencyType;
+    /**
+     * A list of object containing subaccount code
+     * and number of shares: [{subaccount: ‘ACT_xxxxxxxxxx’, share: xxx},{...}]
+     */
+    subaccounts: SplitSubAccount[];
+    /**
+     * Any of subaccount | account | all-proportional | all
+     */
+    bearer_type: string;
+    /**
+     * Subaccount code
+     */
+    bearer_subaccount: string;
+}
+export interface ListSplitQueryParams {
+    /**
+     * The name of the split
+     */
+    name?: string;
+    /**
+     * Any of true or false
+     */
+    active?: boolean;
+    /**
+     * Sort by name, defaults to createdAt dat
+     */
+    sort_by?: string;
+    /**
+     * Number of splits per page. If not specify we use a default value of 50.
+     */
+    perPage?: number;
+    /**
+     * Page number to view. If not specify we use a default value of 1.
+     * @default 1
+     */
+    page?: number;
+    /**
+     * A timestamp from which to start listing splits e.g. 2019-09-24T00:00:05.000Z, 2019-09-21
+     */
+    from?: Date;
+    /**
+     * A timestamp at which to stop listing splits e.g. 2019-09-24T00:00:05.000Z, 2019-09-21
+     */
+    to?: Date;
+}
+interface TransactionSplit {
+    id: number;
+    name: string;
+    type: string;
+    currency: SplitCurrrencyType;
+    integration: number;
+    domain: string;
+    split_code: string;
+    active: boolean;
+    bearer_type: string;
+    bearer_subaccount: number;
+    createdAt: Date;
+    updatedAt: Date;
+    subaccounts: {
+        subaccount: SubAccount;
+        share: number;
+    }[];
+    total_subaccounts?: number;
+}
+export interface UpdateTransactionSplit {
+    name: string;
+    active: boolean;
+    bearer_type?: string;
+    bearer_subaccount?: string;
+}
+export interface Response {
+    status: boolean;
+    message: string;
+}
+export interface SplitCreatedResponse extends Response {
+    data: TransactionSplit;
+}
+export interface ListSplitsResponse extends Response {
+    data: TransactionSplit[];
+    meta: Meta;
+}
+export interface TransactionSplitResponse extends Response {
+    data: TransactionSplit;
+}
+export interface UpdateTransactionSplitResponse extends Response {
+    data: TransactionSplit;
+}
+export {};

package/dist/split/interface.js

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

package/dist/split/split.d.ts

@@ -0,0 +1,36 @@
+import { Axios } from 'axios';
+import { BadRequest, CreateSplit, ListSplitQueryParams, ListSplitsResponse, Response, SplitCreatedResponse, SplitSubAccount, TransactionSplitResponse, UpdateTransactionSplit, UpdateTransactionSplitResponse } from './interface';
+/**
+ * The Transaction Splits API enables merchants
+ * split the settlement for a transaction across
+ * their payout account, and one or more Subaccounts.
+ */
+export declare class TransactionSplit {
+    private http;
+    constructor(http: Axios);
+    /**
+     * Create a split payment on your integration
+     */
+    create(data: CreateSplit): Promise<SplitCreatedResponse | BadRequest>;
+    /**
+     * List/search for the transaction splits available on your integration.
+     */
+    list(queryParams?: ListSplitQueryParams): Promise<ListSplitsResponse | BadRequest>;
+    /**
+     * Get details of a split on your integration.
+     */
+    fetch(splitId: string): Promise<TransactionSplitResponse | BadRequest>;
+    /**
+     * Update a transaction split details on your integration
+     */
+    update(splitId: string, data: UpdateTransactionSplit): Promise<UpdateTransactionSplitResponse | BadRequest>;
+    /**
+     * Add a Subaccount to a Transaction Split,
+     * or update the share of an existing Subaccount in a Transaction Split
+     */
+    add(splitId: string, data: SplitSubAccount): Promise<TransactionSplitResponse | BadRequest>;
+    /**
+     * Remove a subaccount from a transaction split
+     */
+    remove(splitId: string, subaccount: string): Promise<Response | BadRequest>;
+}

package/dist/split/split.js

@@ -0,0 +1,95 @@
+"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.TransactionSplit = void 0;
+/**
+ * The Transaction Splits API enables merchants
+ * split the settlement for a transaction across
+ * their payout account, and one or more Subaccounts.
+ */
+class TransactionSplit {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Create a split payment on your integration
+     */
+    create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.request({
+                url: '/split',
+                data: JSON.stringify(data),
+                method: 'post',
+            });
+        });
+    }
+    /**
+     * List/search for the transaction splits available on your integration.
+     */
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.request({
+                url: '/split',
+                params: Object.assign({}, queryParams),
+                method: 'get',
+            });
+        });
+    }
+    /**
+     * Get details of a split on your integration.
+     */
+    fetch(splitId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.request({
+                url: `/split/${splitId}`,
+                method: 'get',
+            });
+        });
+    }
+    /**
+     * Update a transaction split details on your integration
+     */
+    update(splitId, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.request({
+                url: `/split/${splitId}`,
+                data: JSON.stringify(data),
+                method: 'put',
+            });
+        });
+    }
+    /**
+     * Add a Subaccount to a Transaction Split,
+     * or update the share of an existing Subaccount in a Transaction Split
+     */
+    add(splitId, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.request({
+                url: `/split/${splitId}/subaccount/add`,
+                data: JSON.stringify(data),
+                method: 'post',
+            });
+        });
+    }
+    /**
+     * Remove a subaccount from a transaction split
+     */
+    remove(splitId, subaccount) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.request({
+                url: `/split/${splitId}/subaccount/remove`,
+                data: JSON.stringify({ subaccount }),
+                method: 'post',
+            });
+        });
+    }
+}
+exports.TransactionSplit = TransactionSplit;

package/dist/transaction/interface.d.ts

@@ -84,47 +84,48 @@ export interface TransactionInitialized extends Response {
         reference: string;
     };
 }
-export interface TransactionData extends Response {
-    data: {
-        amount: number;
-        currency: string;
-        transaction_date: Date;
-        status: string;
-        reference: string;
-        domain: string;
-        metadata: number;
-        gateway_response: string;
-        message?: string;
-        channel: string;
-        ip_address: string;
-        log: [
-            {
-                time_spent: number;
-                attempt: number;
-                authentication: any;
-                errors: number;
-                success: boolean;
-                mobile: boolean;
-                input: [];
-                channel: string;
-                history: [
-                    {
-                        type: string;
-                        message: string;
-                        time: number;
-                    }
-                ];
-            }
-        ];
-        fees: number;
-        authorization: Authorization;
-        customer: Customer;
-        pin: string;
-        required_amount: number;
-    };
+interface Transaction {
+    amount: number;
+    currency: string;
+    transaction_date: Date;
+    status: string;
+    reference: string;
+    domain: string;
+    metadata: number;
+    gateway_response: string;
+    message?: string;
+    channel: string;
+    ip_address: string;
+    log: [
+        {
+            time_spent: number;
+            attempt: number;
+            authentication: any;
+            errors: number;
+            success: boolean;
+            mobile: boolean;
+            input: [];
+            channel: string;
+            history: [
+                {
+                    type: string;
+                    message: string;
+                    time: number;
+                }
+            ];
+        }
+    ];
+    fees: number;
+    authorization: Authorization;
+    customer: Customer;
+    pin: string;
+    required_amount: number;
+}
+export interface GetTransactionResponse extends Response {
+    data: Transaction;
 }
 export interface ListTransactions extends Response {
-    data: TransactionData[];
+    data: Transaction[];
     meta: Meta;
 }
 export interface Timeline extends Response {
@@ -307,3 +308,4 @@ export interface CheckAuthorizationResponse extends Response {
         currency: string;
     };
 }
+export {};

package/dist/transaction/transaction.d.ts

@@ -1,5 +1,5 @@
 import { Axios } from 'axios';
-import { CheckAuthorizationResponse, ExportTransaction, ListTransactions, PartialDebitResponse, Timeline, TransactionData } from './interface';
+import { CheckAuthorizationResponse, ExportTransaction, ListTransactions, PartialDebitResponse, Timeline, GetTransactionResponse } from './interface';
 import { ChargeAuthorization, CheckAuthorization, InitializeTransaction, ListTransactionQueryParams, PartialDebit, TransactionInitialized } from './interface';
 interface BadRequest {
     status: boolean;
@@ -19,10 +19,10 @@ export declare class Transaction {
      * @param {InitializeTransaction} data **Body Param**
      */
     initialize(data: InitializeTransaction): Promise<TransactionInitialized | BadRequest>;
-    verify(reference: string): Promise<TransactionData | BadRequest>;
+    verify(reference: string): Promise<GetTransactionResponse | BadRequest>;
     list(queryParams?: ListTransactionQueryParams): Promise<ListTransactions | BadRequest>;
-    fetch(id: string): Promise<TransactionData | BadRequest>;
-    chargeAuthorization(data: ChargeAuthorization): Promise<TransactionData | BadRequest>;
+    fetch(id: string): Promise<GetTransactionResponse | BadRequest>;
+    chargeAuthorization(data: ChargeAuthorization): Promise<GetTransactionResponse | BadRequest>;
     checkAuthorization(data: CheckAuthorization): Promise<CheckAuthorizationResponse | BadRequest>;
     viewTimeline(id: string): Promise<Timeline | BadRequest>;
     total(queryParams: ListTransactionQueryParams): Promise<ListTransactions | BadRequest>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "1.2.0",
+  "version": "2.1.0",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Tech Priest",
@@ -18,8 +18,8 @@
   },
   "devDependencies": {
     "@types/node": "16.11.11",
-    "@typescript-eslint/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/parser": "^5.10.0",
+    "@typescript-eslint/eslint-plugin": "5.36.2",
+    "@typescript-eslint/parser": "5.36.2",
     "eslint": "8.6.0",
     "prettier": "2.5.1",
     "ts-node": "10.4.0",
@@ -29,7 +29,7 @@
     "typescript-eslint": "0.0.1-alpha.0"
   },
   "dependencies": {
-    "axios": "^0.24.0"
+    "axios": "0.24.0"
   },
   "files": [
     "dist/**/*"

package/CHANGELOG.md

@@ -1,29 +0,0 @@
-#### 1.0.4 (2021-12-06)
-
-##### Other Changes
-
-* **plan:**  added methods for plan ([d68ff371](https://github.com/en1tan/paystack-node/commit/d68ff371a90b363ea087bbd5d7cfbece14ca216b))
-
-#### 1.0.3 (2021-12-06)
-
-##### Other Changes
-
-* **transactions:**  added initialize transaction, verify transaction, list transactions ([73c85a83](https://github.com/en1tan/paystack-node/commit/73c85a83b1ae52b4be63e3d77b8c8ff64588b8e2))
-* **charge:**  compeleted the endpoints, what remains is custom validtion and comments ([cc3165ce](https://github.com/en1tan/paystack-node/commit/cc3165ce772ac574cdfbcda082ff22f67e9c8945))
-
-#### 1.0.3 (2021-12-06)
-
-##### Other Changes
-
-* **charge:**  compeleted the endpoints, what remains is custom validtion and comments ([cc3165ce](https://github.com/en1tan/paystack-node/commit/cc3165ce772ac574cdfbcda082ff22f67e9c8945))
-
-- ✍🏻 UPDATE(charge): compeleted the endpoints, what remains is custom validtion and comments
-- 1.0.3
-- ✍🏻 UPDATE(charge): compeleted the endpoints, what remains is custom validtion and comments
-- 1.0.2
-- 🐞 FIX(main entry file):
-- 1.0.1
-- ✍🏻 UPDATE(travis): for automated builds
-- 🐞 FIX(main entry file):
-- 📦 NEW(set up sdk):
-- Initial commit