paystack-sdk 1.0.19 → 1.1.21

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+#### 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

package/README.md

@@ -17,7 +17,7 @@ For NPM
 For Typescript
 
 ```
-import Paystack from 'paystack-sdk';
+import {Paystack} from 'paystack-sdk';
 
 const paystack = new Paystack("secret_key);
 ```
@@ -25,7 +25,7 @@ const paystack = new Paystack("secret_key);
 For Javscript
 
 ```
-const Paystack = require('paystack-sdk');
+const Paystack = require('paystack-sdk').Paystack;
 const paystack = new Paystack("secret_key");
 ```
 
@@ -33,7 +33,11 @@ All methods use promise meaning you can either use the `async...await` or `then.
 
 ### Available Functions
 
-- [Charge](https://github.com/en1tan/paystack-node/blob/main/src/charge/README.md)
-- [Transaction](https://github.com/en1tan/paystack-node/blob/main/src/transaction/README.md)
-- [Plan](https://github.com/en1tan/paystack-node/blob/main/src/plan/README.md)
-- [Customer](https://github.com/en1tan/paystack-node/blob/main/src/customer/README.md)
+- Charge
+- Customer
+- Plan
+- Product
+- Subscription
+- Transaction
+- Transfer
+- dedicated (For dedicated accounts)

package/dist/charge/interface.d.ts

@@ -159,13 +159,14 @@ export interface Authorization {
     account_name: string;
 }
 export interface Customer {
-    customer_code: string;
-    email: string;
     id: number;
-    risk_action: string;
     first_name?: string;
     last_name?: string;
+    email: string;
+    customer_code: string;
+    risk_action: string;
     phone?: string | null;
     metadata?: Record<string, unknown> | null;
+    international_format_phone?: string | null;
 }
 export {};

package/dist/dedicated/dedicated.d.ts

@@ -0,0 +1,18 @@
+import { Axios } from 'axios';
+import { CreateDedicatedVirtualAccount, DeactivateDedicatedAccountResponse, DedicatedAccountCreatedResponse, FetchBankProvidersResponse, FetchDedicatedVirtualAccountResponse, ListDedicatedVirtualAccountsQueryParams, ListDedicatedVirtualAccountsResponse, RemoveSplitDedicatedAccountResponse, SplitDedicatedAccountTransaction, SplitDedicatedAccountTransactionResponse } from './interface';
+interface BadRequest {
+    status: boolean;
+    message: string;
+}
+export declare class DedicatedAccount {
+    http: Axios;
+    constructor(http: Axios);
+    create(data: CreateDedicatedVirtualAccount): Promise<DedicatedAccountCreatedResponse | BadRequest>;
+    list(queryParams: ListDedicatedVirtualAccountsQueryParams): Promise<ListDedicatedVirtualAccountsResponse | BadRequest>;
+    fetch(dedicatedAccountId: string): Promise<FetchDedicatedVirtualAccountResponse | BadRequest>;
+    deactivate(dedicatedAccountId: string): Promise<DeactivateDedicatedAccountResponse | BadRequest>;
+    splitTransaction(data: SplitDedicatedAccountTransaction): Promise<SplitDedicatedAccountTransactionResponse | BadRequest>;
+    removeSplit(accountNumber: string): Promise<RemoveSplitDedicatedAccountResponse | BadRequest>;
+    providers(): Promise<FetchBankProvidersResponse | BadRequest>;
+}
+export {};

package/dist/dedicated/dedicated.js

@@ -0,0 +1,53 @@
+"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.DedicatedAccount = void 0;
+class DedicatedAccount {
+    constructor(http) {
+        this.http = http;
+    }
+    create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/dedicated_account', JSON.stringify(data));
+        });
+    }
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/dedicated_account', { params: Object.assign({}, queryParams) });
+        });
+    }
+    fetch(dedicatedAccountId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/dedicated_account/${dedicatedAccountId}`);
+        });
+    }
+    deactivate(dedicatedAccountId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.delete(`/dedicated_account/${dedicatedAccountId}`);
+        });
+    }
+    splitTransaction(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/dedicated_account/split', JSON.stringify(data));
+        });
+    }
+    removeSplit(accountNumber) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.delete('/dedicated_account/split', { data: { account_number: accountNumber } });
+        });
+    }
+    providers() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/dedicated_account/available_providers');
+        });
+    }
+}
+exports.DedicatedAccount = DedicatedAccount;

package/dist/dedicated/index.js

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

package/dist/dedicated/interface.d.ts

@@ -0,0 +1,157 @@
+import { Authorization, Customer } from '../charge';
+import { Meta } from '../interface';
+import { Subscription } from '../subscription';
+import { Response, TransactionData } from '../transaction';
+export interface DedicatedAccountData {
+    id: number;
+    account_name: string;
+    account_number: string;
+    assigned: boolean;
+    currency: string;
+    metadata: Record<string, any> | null;
+    active: boolean;
+    split_config: Record<string, any> | null;
+    bank: Bank;
+    slug: string;
+    created_at: string;
+    updated_at: string;
+    assignment: Assignment;
+    customer: Customer;
+}
+export interface CreateDedicatedVirtualAccount {
+    customer: string;
+    preferred_bank: string;
+    subaccount?: string;
+    split_code?: string;
+    first_name?: string;
+    last_name?: string;
+    phone?: string;
+}
+export interface ListDedicatedVirtualAccountsQueryParams {
+    active: boolean;
+    currency: string;
+    provider_slug?: string;
+    bank_id?: string;
+    customer?: string;
+}
+export interface SplitDedicatedAccountTransaction {
+    customer: string;
+    subaccount?: string;
+    split_code?: string;
+    preferred_bank?: string;
+}
+export interface ListDedicatedVirtualAccountsResponse extends Response {
+    data: DedicatedAccountData[];
+    meta: Meta;
+}
+export interface DedicatedAccountCreatedResponse extends Response {
+    data: DedicatedAccountData;
+}
+export interface FetchDedicatedVirtualAccountResponse extends Response {
+    data: {
+        transactions: TransactionData[];
+        subscriptions: Subscription[];
+        authorizations: Authorization[];
+        first_name: string;
+        last_name: string;
+        email: string;
+        phone: string;
+        metadata: Record<string, any> | null;
+        domain: string;
+        customer_code: string;
+        risk_action: string;
+        id: number;
+        integration: number;
+        createdAt: Date;
+        updatedAt: Date;
+        created_at: Date;
+        updated_at: Date;
+        total_transactions: number;
+        total_transaction_value: any[];
+        dedicated_account: {
+            id: number;
+            account_name: string;
+            account_number: string;
+            created_at: Date;
+            updated_at: Date;
+            currency: string;
+            active: boolean;
+            assigned: boolean;
+            provider: {
+                id: number;
+                provider_slug: string;
+                bank_id: number;
+                bank_name: string;
+            };
+            assignment: Assignment;
+        };
+    };
+}
+export interface DeactivateDedicatedAccountResponse {
+    data: {
+        bank: Bank;
+        account_name: string;
+        account_number: string;
+        assigned: boolean;
+        currency: string;
+        metadata: Record<string, any> | null;
+        active: boolean;
+        id: number;
+        created_at: Date;
+        updated_at: Date;
+        assignment: Assignment;
+    };
+}
+export interface SplitDedicatedAccountTransactionResponse extends Response {
+    data: {
+        id: number;
+        account_name: string;
+        account_number: string;
+        assigned: boolean;
+        currency: string;
+        metadata: Record<string, any> | null;
+        active: boolean;
+        bank: Bank;
+        assignment: Assignment;
+        created_at: Date;
+        updated_at: Date;
+        split_config: Record<string, any> | null;
+        customer: Customer;
+    };
+}
+export interface RemoveSplitDedicatedAccountResponse extends Response {
+    data: {
+        id: number;
+        account_name: string;
+        account_number: string;
+        assigned: boolean;
+        currency: string;
+        split_config: Record<string, any> | null;
+        active: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+    };
+}
+export interface FetchBankProvidersResponse extends Response {
+    data: {
+        id: number;
+        provider_slug: string;
+        bank_id: number;
+        bank_name: string;
+    }[];
+}
+interface Bank {
+    id: number;
+    name: string;
+    slug: string;
+}
+interface Assignment {
+    integration: number;
+    assignee_id: number;
+    assignee_type: string;
+    expired: boolean;
+    account_type: string;
+    assigned_at: Date;
+    expired_at: Date | null;
+}
+export {};

package/dist/dedicated/interface.js

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

package/dist/paystack.d.ts

@@ -1,5 +1,6 @@
 import { Charge } from './charge';
 import { Customer } from './customer';
+import { DedicatedAccount } from './dedicated/dedicated';
 import { Plan } from './plan';
 import { Product } from './product/product';
 import { Subscription } from './subscription/subscription';
@@ -14,6 +15,7 @@ export declare class Paystack {
     private readonly http;
     charge: Charge;
     customer: Customer;
+    dedicated: DedicatedAccount;
     plan: Plan;
     product: Product;
     subscription: Subscription;

package/dist/paystack.js

@@ -4,6 +4,7 @@ exports.Paystack = void 0;
 const axios_1 = require("axios");
 const charge_1 = require("./charge");
 const customer_1 = require("./customer");
+const dedicated_1 = require("./dedicated/dedicated");
 const plan_1 = require("./plan");
 const product_1 = require("./product/product");
 const subscription_1 = require("./subscription/subscription");
@@ -31,6 +32,7 @@ class Paystack {
         this.subscription = new subscription_1.Subscription(this.http);
         this.transaction = new transaction_1.Transaction(this.http);
         this.transfer = new transfer_1.Transfer(this.http);
+        this.dedicated = new dedicated_1.DedicatedAccount(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/transaction/transaction.d.ts

@@ -1,5 +1,5 @@
 import { Axios } from 'axios';
-import { CheckAuthorizationResponse, ExportTransaction, ListTransactions, PartialDebitResponse, Timeline, TransactionData } from '.';
+import { CheckAuthorizationResponse, ExportTransaction, ListTransactions, PartialDebitResponse, Timeline, TransactionData } from './interface';
 import { ChargeAuthorization, CheckAuthorization, InitializeTransaction, ListTransactionQueryParams, PartialDebit, TransactionInitialized } from './interface';
 interface BadRequest {
     status: boolean;

package/package.json

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