paystack-sdk 2.2.0 → 2.3.1

package/README.md

@@ -26,25 +26,45 @@ For Javscript
 
 ```javascript
 const Paystack = require('paystack-sdk').Paystack;
-const paystack = new Paystack("secret_key");
+const paystack = new Paystack('secret_key');
 ```
 
-All methods use promise meaning you can either use the `async...await` or `then...catch` or `try...catch`
+OR
 
-### Available Functions
+```javascript
+const { Paystack } = require('paystack-sdk').Paystack;
+const paystack = new Paystack('secret_key');
+```
 
-- Charge
-- Customer
-- Plan
-- Product
-- Subscription
-- Transaction
-- Transfer
-- dedicated (For dedicated accounts)
+All methods use promise meaning you can either use the `async...await` or `then...catch` or `try...catch`
 
+### Modules
+
+- [x] Charge
+- [x] Customers
+- [x] Plans
+- [x] Products
+- [x] Subscriptions
+- [x] Transactions
+- [x] Transfers
+- [x] Dedicated Virtual Accounts
+- [x] Apple Pay
+- [x] Subaccounts
+- [x] Transaction Splits
+- [x] Settlements
+- [x] Invoices
+- [ ] Transaction Recipients
+- [ ] Transfers Control
+- [ ] Bulk Charges
+- [ ] Control Panel
+- [ ] Disputes
+- [ ] Refunds
+- [ ] Verification
+- [ ] Miscellaneous
 
 ## 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:
+You will need to fork the repo and create a PR against it with your changes.  
+Thank you :smile:

package/dist/charge/interface.d.ts

@@ -1,4 +1,4 @@
-import { Response } from '../transaction';
+import { Response } from '../interface';
 export declare type ChargeCreatedResponse = ChargeCreated | ChargeCreatedWithOTP | ChargeCreatedWithPending | ChargeCreatedWithAddress | ChargeCreatedWithBankAuth | ChargeCreatedWithPin | ChargeCreatedWithPhone | ChargeCreatedWithBirthday | ChargeCreatedWithUSSD | ChargeCreatedWithMobileMoney | ChargeFailed;
 export interface CreateCharge {
     email: string;

package/dist/customer/customer.d.ts

@@ -1,11 +1,7 @@
 import { Axios } from 'axios';
-import { ListCustomersResponse } from '.';
-import { CreateCustomer, CustomerCreated, CustomerData, ListCustomerQueryParams, SetRiskAction, UpdateCustomer, ValidateCustomer } from './interface';
-interface BadRequest {
-    status: boolean;
-    message: string;
-    data: null;
-}
+import { BadRequest } from '../interface';
+import { ListCustomersResponse } from './interface';
+import { CreateCustomer, CustomerCreated, FetchCustomerResponse, ListCustomerQueryParams, SetRiskAction, UpdateCustomer, ValidateCustomer } from './interface';
 /**
  * # Customers
  * The Customers API allows you create and manage
@@ -23,7 +19,6 @@ export declare class Customer {
     /**
      * ## List Customers
      * List customers available on your integration
-     * @param {ListCustomerQueryParams} queryParams
      */
     list(queryParams?: ListCustomerQueryParams): Promise<ListCustomersResponse | BadRequest>;
     /**
@@ -31,30 +26,25 @@ export declare class Customer {
      * Get details of a customer on your integration
      * @param {String} email_or_code
      */
-    fetch(emailCode: string): Promise<CustomerData | BadRequest>;
+    fetch(emailCode: string): Promise<FetchCustomerResponse | BadRequest>;
     /**
      * ## Update CUstomer
      * Update a customer's details on your integration
      */
-    update(code: string, data: UpdateCustomer): Promise<CustomerData | BadRequest>;
+    update(code: string, data: UpdateCustomer): Promise<FetchCustomerResponse | BadRequest>;
     /**
      * ## Validate Customer
      * Validate a customer's identity
-     * @param {String} customer_code
-     * @param {ValidateCustomer} data
      */
     validate(customerCode: string, data: ValidateCustomer): Promise<Response | BadRequest>;
     /**
      * ## Whitelist/Blacklist Customer
      * Whitelist or black a customer on your integration
-     * @param {SetRiskAction} data
      */
-    setRiskAction(data: SetRiskAction): Promise<CustomerData | BadRequest>;
+    setRiskAction(data: SetRiskAction): Promise<FetchCustomerResponse | BadRequest>;
     /**
      * ## Deactivate Authorization
      * Deactivate an authorization when the card needs to be forgotten
-     * @param {String} authorizaion_code
      */
     deactivateAutorization(authorizationCode: string): Promise<Response>;
 }
-export {};

package/dist/customer/customer.js

@@ -32,7 +32,6 @@ class Customer {
     /**
      * ## List Customers
      * List customers available on your integration
-     * @param {ListCustomerQueryParams} queryParams
      */
     list(queryParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -63,8 +62,6 @@ class Customer {
     /**
      * ## Validate Customer
      * Validate a customer's identity
-     * @param {String} customer_code
-     * @param {ValidateCustomer} data
      */
     validate(customerCode, data) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -74,7 +71,6 @@ class Customer {
     /**
      * ## Whitelist/Blacklist Customer
      * Whitelist or black a customer on your integration
-     * @param {SetRiskAction} data
      */
     setRiskAction(data) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -84,12 +80,10 @@ class Customer {
     /**
      * ## Deactivate Authorization
      * Deactivate an authorization when the card needs to be forgotten
-     * @param {String} authorizaion_code
      */
     deactivateAutorization(authorizationCode) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/customer/deactivate_authorization', JSON.stringify({ authorizaion_code: authorizationCode }));
-            return response;
+            return yield this.http.post('/customer/deactivate_authorization', JSON.stringify({ authorizaion_code: authorizationCode }));
         });
     }
 }

package/dist/customer/interface.d.ts

@@ -1,7 +1,8 @@
 import { Authorization } from '../charge';
 import { Meta } from '../interface';
+import { SubAccount } from '../subaccounts/subaccount';
 import { Subscription } from '../subscription/interface';
-import { Transaction } from '../transaction';
+import { Transaction } from '../transaction/interface';
 export interface CreateCustomer {
     email: string;
     first_name: string;
@@ -13,64 +14,35 @@ export interface Response {
     status: boolean;
     message: string;
 }
+export interface Customer {
+    id: number;
+    transactions: Transaction[];
+    subscriptions: Subscription[];
+    authorizations: Authorization[];
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone?: string;
+    metadata?: Record<string, unknown>;
+    domain: string;
+    customer_code: string;
+    risk_action: string;
+    international_format_phone?: string;
+    integration: number;
+    createdAt: Date;
+    updatedAt: Date;
+    identified: boolean;
+    identifications: CustomerIdentification[];
+    dedicated_account: DedicatedAccount[];
+}
 export interface CustomerCreated extends Response {
-    data: {
-        transactions: Transaction[];
-        subscriptions: Subscription[];
-        authorizations: Authorization[];
-        first_name: string;
-        last_name: string;
-        email: string;
-        phone: string | null;
-        metadata?: Record<string, unknown>;
-        domain: string;
-        customer_code: string;
-        risk_action: string;
-        id: number;
-        integration: number;
-        createdAt: Date;
-        updatedAt: Date;
-        identified: boolean;
-        identifications: null;
-    };
+    data: Customer;
 }
-export interface CustomerData extends Response {
-    data: {
-        integration: number;
-        first_name: string;
-        last_name: string;
-        email: string;
-        phone: string | null;
-        dedicated_account: DedicatedAccount | null;
-        identified: boolean;
-        identifications: CustomerIdentification[] | null;
-        metadata: Record<string, any> | null;
-        domain: string;
-        customer_code: string;
-        id: string;
-        transactions: Transaction[];
-        subscriptions: Subscription[];
-        authorizations: Authorization[];
-        createdAt: Date;
-        updatedAt: Date;
-    };
+export interface FetchCustomerResponse extends Response {
+    data: Customer;
 }
 export interface ListCustomersResponse extends Response {
-    data: [
-        {
-            integration: number;
-            first_name: string;
-            last_name: string;
-            email: string;
-            phone: string | null;
-            metadata: Record<string, any> | null;
-            domain: string;
-            customer_code: string;
-            id: number;
-            createdAt: Date;
-            updatedAt: Date;
-        }
-    ];
+    data: Customer[];
     meta: Meta;
 }
 export interface ListCustomerQueryParams {
@@ -118,23 +90,11 @@ export interface SplitConfig {
     createdAt: Date;
     updatedAt: Date;
     is_dynamic: boolean;
-    subaccounts: SubAccount[];
+    subaccounts: CustomerSubAccount[];
     total_subaccounts: number;
 }
-export interface SubAccount {
-    subaccount: {
-        id: number;
-        sunaccount_code: string;
-        business_name: string;
-        description: string;
-        primary_contact_name: string | null;
-        primary_contact_email: string | null;
-        primary_contact_phone: string | null;
-        metadata: Record<string, any>;
-        settlement_bank: string;
-        currency: string;
-        account_number: string;
-    };
+export interface CustomerSubAccount {
+    subaccount: SubAccount;
     share: number;
 }
 export interface CustomerIdentification {
@@ -168,7 +128,7 @@ export interface UpdateCustomer {
     first_name: string;
     last_name: string;
     phone: string;
-    metadata: Record<string, any>;
+    metadata: Record<string, unknown>;
 }
 export interface SetRiskAction {
     customer: string;

package/dist/dedicated/interface.d.ts

@@ -1,16 +1,17 @@
 import { Authorization, Customer } from '../charge';
 import { Meta } from '../interface';
 import { Subscription } from '../subscription';
-import { Response, Transaction } from '../transaction';
+import { Response } from '../interface';
+import { Transaction } from '../transaction/interface';
 export interface DedicatedAccountData {
     id: number;
     account_name: string;
     account_number: string;
     assigned: boolean;
     currency: string;
-    metadata: Record<string, any> | null;
+    metadata?: Record<string, unknown>;
     active: boolean;
-    split_config: Record<string, any> | null;
+    split_config?: Record<string, unknown>;
     bank: Bank;
     slug: string;
     created_at: string;
@@ -56,7 +57,7 @@ export interface FetchDedicatedVirtualAccountResponse extends Response {
         last_name: string;
         email: string;
         phone: string;
-        metadata: Record<string, any> | null;
+        metadata?: Record<string, unknown>;
         domain: string;
         customer_code: string;
         risk_action: string;
@@ -67,7 +68,7 @@ export interface FetchDedicatedVirtualAccountResponse extends Response {
         created_at: Date;
         updated_at: Date;
         total_transactions: number;
-        total_transaction_value: any[];
+        total_transaction_value: unknown[];
         dedicated_account: {
             id: number;
             account_name: string;
@@ -94,7 +95,7 @@ export interface DeactivateDedicatedAccountResponse {
         account_number: string;
         assigned: boolean;
         currency: string;
-        metadata: Record<string, any> | null;
+        metadata?: Record<string, unknown>;
         active: boolean;
         id: number;
         created_at: Date;
@@ -109,13 +110,13 @@ export interface SplitDedicatedAccountTransactionResponse extends Response {
         account_number: string;
         assigned: boolean;
         currency: string;
-        metadata: Record<string, any> | null;
+        metadata?: Record<string, unknown>;
         active: boolean;
         bank: Bank;
         assignment: Assignment;
         created_at: Date;
         updated_at: Date;
-        split_config: Record<string, any> | null;
+        split_config?: Record<string, unknown>;
         customer: Customer;
     };
 }
@@ -126,7 +127,7 @@ export interface RemoveSplitDedicatedAccountResponse extends Response {
         account_number: string;
         assigned: boolean;
         currency: string;
-        split_config: Record<string, any> | null;
+        split_config?: Record<string, unknown>;
         active: boolean;
         createdAt: Date;
         updatedAt: Date;

package/dist/interface.d.ts

@@ -14,3 +14,23 @@ export interface Response {
     status: boolean;
     message: string;
 }
+export interface QueryParams {
+    /**
+     * Specify how many records you want to retrieve per page.
+     * If not specify we use a default value of 50.
+     */
+    perPage?: number;
+    /**
+     * Specify exactly what page you want to retrieve.
+     * If not specify we use a default value of 1.
+     */
+    page?: number;
+    /**
+     * A timestamp from which to start listing subaccounts e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
+     */
+    from?: Date;
+    /**
+     * A timestamp at which to stop listing subaccounts e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
+     */
+    to?: Date;
+}

package/dist/invoice/interface.d.ts

@@ -0,0 +1,137 @@
+import { Customer } from '../charge';
+import { Meta, QueryParams, Response } from '../interface';
+import { Transaction } from '../transaction/interface';
+export interface CreateInvoice {
+    /** Customer id or code */
+    customer: string;
+    /**
+     * Payment request amount.
+     * It should be used when line items and tax values aren't specified.
+     */
+    amount: number;
+    /** ISO 8601 representation of request due date */
+    date_time?: Date;
+    /** A short description of the payment request */
+    description?: string;
+    /**
+     * Array of line items int the format
+     * [{"name":"item 1", "amount":2000, "quantity": 1}]
+     */
+    line_items?: Record<string, unknown>[];
+    /**
+     * Array of taxes to be charged in the format
+     * [{"name":"VAT", "amount":2000}]
+     */
+    tax?: Record<string, unknown>[];
+    /**
+     * Specify the currency of the invoice.
+     * Allowed values are `NGN`, `GHS`, `ZAR` and `USD`. Defaults to NGN
+     */
+    currency?: string;
+    /**
+     * Indicates whether Paystack sends an email notification to customer.
+     * Defaults to true
+     */
+    send_notification?: boolean;
+    /**
+     * Indicate if request should be saved as draft.
+     * Defaults to false and overrides send_notification
+     */
+    draft?: boolean;
+    /**
+     * Set to true to create a draft invoice
+     * (adds an auto incrementing invoice number if none is provided)
+     * even if there are no line_items or tax passed
+     */
+    has_invoice?: boolean;
+    /**
+     * Numeric value of invoice.
+     * Invoice will start from 1 and auto increment from there.
+     * This field is to help override whatever value Paystack decides.
+     * Auto increment for subsequent invoices continue from this point.
+     */
+    invoice_number?: number;
+    /** The split code of the transaction split. e.g. SPL_98WF13Eb3w */
+    split_code?: string;
+}
+export interface InvoiceQueryParams extends QueryParams {
+    /** Filter by customer ID */
+    customer?: string;
+    /** Filter by invoice status */
+    status?: string;
+    /**
+     * Filter by currency.
+     * Allowed values are NGN, GHS, ZAR and USD.
+     */
+    currency?: string;
+    /** Show archived invoices */
+    include_archive?: string;
+}
+export declare type UpdateInvoice = CreateInvoice;
+interface InvoiceLineItem {
+    name: string;
+    amount: number;
+    quantity: number;
+}
+interface InvoiceTax {
+    name: string;
+    amount: number;
+}
+interface IInvoiceTotal {
+    currency: string;
+    amount: number;
+}
+export interface Invoice {
+    id: number;
+    domain: string;
+    amount: number;
+    discount?: unknown;
+    currency: string;
+    due_date: Date;
+    has_invoice: boolean;
+    invoice_number: number;
+    description: string;
+    line_items: InvoiceLineItem[];
+    tax: InvoiceTax[];
+    request_code: string;
+    status: string;
+    paid: boolean;
+    paid_at?: Date;
+    metadata?: Record<string, unknown>;
+    notifications: unknown[];
+    offline_reference: string;
+    pdf_url?: string;
+    transactions: Transaction[];
+    archived?: boolean;
+    source?: string;
+    payment_method?: unknown;
+    note?: string;
+    amount_paid?: unknown;
+    integration: number;
+    customer?: number | Customer;
+    createdAt: Date;
+    updatedAt: Date;
+    pending_amount?: number;
+}
+export interface InvoiceTotal {
+    pending: IInvoiceTotal[];
+    successful: IInvoiceTotal[];
+    total: IInvoiceTotal[];
+}
+export interface InvoiceCreatedResponse extends Response {
+    data: Invoice;
+}
+export interface ListInvoicesResponse extends Response {
+    data: Invoice[];
+    meta: Meta;
+}
+export interface ViewInvoiceResponse extends Response {
+    data: Invoice;
+}
+export interface VerifyInvoiceResponse extends Response {
+    data: Invoice;
+}
+export interface InvoiceTotalResponse extends Response {
+    data: InvoiceTotal;
+}
+export {};

package/dist/invoice/interface.js

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

package/dist/invoice/invoice.d.ts

@@ -0,0 +1,16 @@
+import { Axios } from 'axios';
+import { BadRequest, Response } from '../interface';
+import { CreateInvoice, InvoiceCreatedResponse, InvoiceQueryParams, InvoiceTotalResponse, ListInvoicesResponse, UpdateInvoice, ViewInvoiceResponse } from './interface';
+export declare class Invoice {
+    private http;
+    constructor(http: Axios);
+    create(data: CreateInvoice): Promise<InvoiceCreatedResponse | BadRequest>;
+    list(queryParams?: InvoiceQueryParams): Promise<ListInvoicesResponse | BadRequest>;
+    view(id: string): Promise<ViewInvoiceResponse | BadRequest>;
+    verify(code: string): Promise<ViewInvoiceResponse | BadRequest>;
+    sendNotification(code: string): Promise<Response | BadRequest>;
+    total(): Promise<InvoiceTotalResponse | BadRequest>;
+    finalize(code: string): Promise<ViewInvoiceResponse | BadRequest>;
+    update(id: string, data: UpdateInvoice): Promise<ViewInvoiceResponse | BadRequest>;
+    archive(code: string): Promise<Response | BadRequest>;
+}

package/dist/invoice/invoice.js

@@ -0,0 +1,65 @@
+"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.Invoice = void 0;
+class Invoice {
+    constructor(http) {
+        this.http = http;
+    }
+    create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/paymentrequest', JSON.stringify(data));
+        });
+    }
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/paymentrequest', {
+                params: Object.assign({}, queryParams),
+            });
+        });
+    }
+    view(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`'/paymentrequest/${id}`);
+        });
+    }
+    verify(code) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/paymentrequest/verify/${code}`);
+        });
+    }
+    sendNotification(code) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post(`/paymentrequest/notify/${code}`);
+        });
+    }
+    total() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/paymentrequest/totals');
+        });
+    }
+    finalize(code) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post(`/paymentrequest/finalize/${code}`);
+        });
+    }
+    update(id, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.put(`/paymentrequest/${id}`, JSON.stringify(data));
+        });
+    }
+    archive(code) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post(`/paymentrequest/archive/${code}`);
+        });
+    }
+}
+exports.Invoice = Invoice;

package/dist/payment/interface.d.ts

@@ -0,0 +1,101 @@
+import { Meta, Response } from '../interface';
+import { ProductCreated } from '../product/interface';
+export interface CreatePage {
+    /**
+     * Name of page
+     */
+    name: string;
+    /**
+     * A description for this page
+     */
+    description?: string;
+    /**
+     * Amount should be in kobo if currency is `NGN`, pesewas,
+     * if currency is `GHS`, and cents, if currency is `ZAR`
+     */
+    amount?: number;
+    /**
+     * URL slug you would like to be associated with this page.
+     * Page will be accessible at https://paystack.com/pay/[slug]
+     */
+    slug?: string;
+    /**
+     * Extra data to configure the payment page including subaccount,
+     * logo image, transaction charge
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * If you would like Paystack to redirect someplace upon successful payment,
+     * specify the URL here.
+     */
+    redirect_url?: string;
+    /**
+     * If you would like to accept custom fields, specify them here.
+     */
+    custom_fields?: Record<string, unknown>[];
+}
+export interface UpdatePage {
+    /**
+     * Name of page
+     */
+    name: string;
+    /**
+     * A description for this page
+     */
+    description: string;
+    /**
+     * Amount should be in kobo if currency is `NGN`, pesewas,
+     * if currency is `GHS`, and cents, if currency is `ZAR`
+     */
+    amount?: number;
+    /**
+     * Set to false to deactivate page url
+     */
+    active?: boolean;
+}
+export interface PaymentPageProduct {
+    product_id: number;
+    name: string;
+    description: string;
+    product_code: string;
+    page: number;
+    price: number;
+    currency: string;
+    quantity: number;
+    type: string;
+    features?: unknown;
+    is_shippable: number;
+    domain: string;
+    integration: number;
+    active: number;
+    in_stock: number;
+}
+export interface PaymentPage {
+    id: number;
+    name: string;
+    description?: string;
+    integration: number;
+    domain: string;
+    slug: string;
+    currency: string;
+    type: string;
+    redirect_url?: string;
+    success_message?: string;
+    collect_phone: boolean;
+    active: boolean;
+    published: boolean;
+    migrate: boolean;
+    notification_email?: string;
+    metadata?: Record<string, unknown>;
+    split_code?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    products?: ProductCreated[];
+}
+export interface PaymentPageCreatedFetchedUpdatedResponse extends Response {
+    data: PaymentPage;
+}
+export interface ListPaymentPagesResponse extends Response {
+    data: PaymentPage[];
+    meta?: Meta;
+}

package/dist/payment/interface.js

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

package/dist/payment/payment.d.ts

@@ -0,0 +1,13 @@
+import { Axios } from 'axios';
+import { BadRequest, QueryParams } from '../interface';
+import { CreatePage, ListPaymentPagesResponse, PaymentPageCreatedFetchedUpdatedResponse, UpdatePage } from './interface';
+export declare class PaymentPage {
+    private http;
+    constructor(http: Axios);
+    create(data: CreatePage): Promise<PaymentPageCreatedFetchedUpdatedResponse | BadRequest>;
+    list(queryParams?: QueryParams): Promise<ListPaymentPagesResponse | BadRequest>;
+    fetch(id: string): Promise<PaymentPageCreatedFetchedUpdatedResponse | BadRequest>;
+    update(id: string, data: UpdatePage): Promise<PaymentPageCreatedFetchedUpdatedResponse | BadRequest>;
+    slugAvailable(slug: string): Promise<PaymentPageCreatedFetchedUpdatedResponse | BadRequest>;
+    addProduct(id: number, products: number[]): Promise<PaymentPageCreatedFetchedUpdatedResponse | BadRequest>;
+}

package/dist/payment/payment.js

@@ -0,0 +1,48 @@
+"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.PaymentPage = void 0;
+class PaymentPage {
+    constructor(http) {
+        this.http = http;
+    }
+    create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/page', JSON.stringify(data));
+        });
+    }
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/page', { params: Object.assign({}, queryParams) });
+        });
+    }
+    fetch(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/page/${id}`);
+        });
+    }
+    update(id, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.put(`/page/${id}`, JSON.stringify(data));
+        });
+    }
+    slugAvailable(slug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/page/check_slug_availability/${slug}`);
+        });
+    }
+    addProduct(id, products) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post(`/page/${id}/product`, JSON.stringify({ products }));
+        });
+    }
+}
+exports.PaymentPage = PaymentPage;

package/dist/paystack.d.ts

@@ -1,20 +1,23 @@
 import { ApplePay } from './apple/apple';
 import { Charge } from './charge';
-import { Customer } from './customer';
+import { Customer } from './customer/customer';
 import { DedicatedAccount } from './dedicated/dedicated';
+import { Invoice } from './invoice/invoice';
+import { PaymentPage } from './payment/payment';
 import { Plan } from './plan';
 import { Product } from './product/product';
+import { Settlement } from './settlement/settlement';
 import { TransactionSplit } from './split/split';
 import { SubAccount } from './subaccounts/subaccount';
 import { Subscription } from './subscription/subscription';
-import { Transaction } from './transaction';
+import { Transaction } from './transaction/transaction';
 import { Transfer } from './transfer/transfer';
 /**
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
  */
 export declare class Paystack {
-    readonly key: string;
+    private readonly key;
     private readonly http;
     charge: Charge;
     customer: Customer;
@@ -27,5 +30,8 @@ export declare class Paystack {
     split: TransactionSplit;
     applePay: ApplePay;
     subAccount: SubAccount;
+    page: PaymentPage;
+    invoice: Invoice;
+    settlement: Settlement;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -4,14 +4,17 @@ exports.Paystack = void 0;
 const axios_1 = require("axios");
 const apple_1 = require("./apple/apple");
 const charge_1 = require("./charge");
-const customer_1 = require("./customer");
+const customer_1 = require("./customer/customer");
 const dedicated_1 = require("./dedicated/dedicated");
+const invoice_1 = require("./invoice/invoice");
+const payment_1 = require("./payment/payment");
 const plan_1 = require("./plan");
 const product_1 = require("./product/product");
+const settlement_1 = require("./settlement/settlement");
 const split_1 = require("./split/split");
 const subaccount_1 = require("./subaccounts/subaccount");
 const subscription_1 = require("./subscription/subscription");
-const transaction_1 = require("./transaction");
+const transaction_1 = require("./transaction/transaction");
 const transfer_1 = require("./transfer/transfer");
 /**
  * Paystack SDK
@@ -39,6 +42,9 @@ class Paystack {
         this.transfer = new transfer_1.Transfer(this.http);
         this.applePay = new apple_1.ApplePay(this.http);
         this.subAccount = new subaccount_1.SubAccount(this.http);
+        this.page = new payment_1.PaymentPage(this.http);
+        this.invoice = new invoice_1.Invoice(this.http);
+        this.settlement = new settlement_1.Settlement(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/settlement/interface.d.ts

@@ -0,0 +1,40 @@
+import { CustomerSubAccount } from '../customer/interface';
+import { Meta, QueryParams } from '../interface';
+export interface SettlementQueryParams extends QueryParams {
+    subaccount?: string;
+}
+export interface Settlement {
+    integration: number;
+    settled_by?: string;
+    settlement_date: Date;
+    domain: string;
+    total_amount: number;
+    status: string;
+    id: number;
+    createdAt: Date;
+    updatedAt?: Date;
+    subaccount: CustomerSubAccount;
+}
+export interface ListSettlementsResponse extends Response {
+    data: Settlement[];
+    meta: Meta;
+}
+export interface SettlementTransaction {
+    id: number;
+    reference: string;
+    amount: number;
+    created_at: Date;
+    paidAt: Date;
+    currency: string;
+    channel: string;
+    domain: string;
+    message?: string;
+    gateway_response: string;
+    fees: number;
+}
+export interface ListSettlementTransactionsResponse extends Response {
+    data: SettlementTransaction[];
+    meta: Meta & {
+        total_volume: number;
+    };
+}

package/dist/settlement/interface.js

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

package/dist/settlement/settlement.d.ts

@@ -0,0 +1,9 @@
+import { Axios } from 'axios';
+import { BadRequest, QueryParams } from '../interface';
+import { ListSettlementsResponse, ListSettlementTransactionsResponse, SettlementQueryParams } from './interface';
+export declare class Settlement {
+    private http;
+    constructor(http: Axios);
+    list(queryParams?: SettlementQueryParams): Promise<ListSettlementsResponse | BadRequest>;
+    transactions(id: string, queryParams: QueryParams): Promise<ListSettlementTransactionsResponse | BadRequest>;
+}

package/dist/settlement/settlement.js

@@ -0,0 +1,30 @@
+"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.Settlement = void 0;
+class Settlement {
+    constructor(http) {
+        this.http = http;
+    }
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/settlement', { params: Object.assign({}, queryParams) });
+        });
+    }
+    transactions(id, queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/settlement/$[id]/transactions`, {
+                params: Object.assign({}, queryParams),
+            });
+        });
+    }
+}
+exports.Settlement = Settlement;

package/dist/subaccounts/interface.d.ts

@@ -53,28 +53,8 @@ export interface CreateUpdateSubAccount {
      */
     metadata?: string;
 }
-export interface SubAccountQueryParams {
-    /**
-     * Specify how many records you want to retrieve per page.
-     * If not specify we use a default value of 50.
-     */
-    perPage?: number;
-    /**
-     * Specify exactly what page you want to retrieve.
-     * If not specify we use a default value of 1.
-     */
-    page?: number;
-    /**
-     * A timestamp from which to start listing subaccounts e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-     */
-    from?: Date;
-    /**
-     * A timestamp at which to stop listing subaccounts e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-     */
-    to?: Date;
-}
 interface SubAccount {
-    integration: number;
+    id: number;
     domain: string;
     subaccount_code: string;
     business_name: string;
@@ -82,7 +62,7 @@ interface SubAccount {
     primary_contact_name?: string;
     primary_contact_email?: string;
     primary_contact_phone?: string;
-    metadata?: Record<string, unknown>;
+    metadata: Record<string, unknown>;
     percentage_charge: number;
     is_verified: boolean;
     settlement_bank: string;
@@ -90,9 +70,10 @@ interface SubAccount {
     settlement_schedule: string;
     active: boolean;
     migrate: boolean;
-    id: number;
+    integration: number;
     createdAt: Date;
     updatedAt: Date;
+    currency: string;
 }
 export interface SubAccountCreatedUpdateResponse extends Response {
     data: SubAccount;

package/dist/subaccounts/subaccount.d.ts

@@ -1,11 +1,11 @@
 import { Axios } from 'axios';
-import { BadRequest } from '../interface';
-import { CreateUpdateSubAccount, FetchSubAccountResponse, ListSubAccountsResponse, SubAccountCreatedUpdateResponse, SubAccountQueryParams } from './interface';
+import { BadRequest, QueryParams } from '../interface';
+import { CreateUpdateSubAccount, FetchSubAccountResponse, ListSubAccountsResponse, SubAccountCreatedUpdateResponse } from './interface';
 export declare class SubAccount {
     private http;
     constructor(http: Axios);
     create(data: CreateUpdateSubAccount): Promise<SubAccountCreatedUpdateResponse | BadRequest>;
-    list(queryParams?: SubAccountQueryParams): Promise<ListSubAccountsResponse>;
+    list(queryParams?: QueryParams): Promise<ListSubAccountsResponse>;
     fetch(id: string): Promise<FetchSubAccountResponse | BadRequest>;
     update(id: string, data: CreateUpdateSubAccount): Promise<SubAccountCreatedUpdateResponse | BadRequest>;
 }

package/dist/subscription/interface.d.ts

@@ -1,5 +1,5 @@
 import { Authorization } from '../charge';
-import { ICustomer } from '../customer';
+import { Customer } from '../customer/interface';
 import { Meta } from '../interface';
 import { IPlan } from '../plan';
 export interface CreateSubscription {
@@ -47,7 +47,7 @@ export interface ListSubscriptions extends Response {
 export interface FetchSubscription extends Response {
     data: {
         invoices: unknown[];
-        customer: ICustomer;
+        customer: Customer;
         plan: IPlan;
         integration: number;
         authorization: Authorization;
@@ -77,7 +77,7 @@ export interface EnableOrDisableSubscription {
     token: string;
 }
 export interface Subscription {
-    customer: ICustomer;
+    customer: Customer;
     plan: IPlan;
     integration: number;
     authorization: Authorization;

package/dist/transaction/interface.d.ts

@@ -84,7 +84,7 @@ export interface TransactionInitialized extends Response {
         reference: string;
     };
 }
-interface Transaction {
+export interface Transaction {
     amount: number;
     currency: string;
     transaction_date: Date;
@@ -308,4 +308,3 @@ export interface CheckAuthorizationResponse extends Response {
         currency: string;
     };
 }
-export {};

package/package.json

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