paystack-sdk 2.5.26 → 3.0.0

package/README.md

@@ -63,7 +63,7 @@ All methods use promise meaning you can either use the `async...await` or `then.
 - [ ] Disputes
 - [x] Refunds
 - [x] Verification
-- [ ] Miscellaneous
+- [x] Miscellaneous
 
 ## CONTRIBUTING
 

package/dist/apple/apple.js

@@ -1,34 +1,19 @@
 "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.ApplePay = void 0;
 class ApplePay {
     constructor(http) {
         this.http = http;
     }
-    registerDomain(domainName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/apple-pay/domain', JSON.stringify({ domainName }));
-        });
+    async registerDomain(domainName) {
+        return await this.http.post('/apple-pay/domain', JSON.stringify({ domainName }));
     }
-    listDomains() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get('/apple-pay');
-        });
+    async listDomains() {
+        return await this.http.get('/apple-pay');
     }
-    unregisterDomain(domainName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.delete('/apple-pay', {
-                params: { domainName },
-            });
+    async unregisterDomain(domainName) {
+        return await this.http.delete('/apple-pay', {
+            params: { domainName },
         });
     }
 }

package/dist/apple/interface.d.ts

@@ -2,8 +2,8 @@ export interface Response {
     status: boolean;
     message: string;
 }
-export declare type DomainRegisterResponse = Response;
-export declare type UnregisterDomainRegisterResponse = Response;
+export type DomainRegisterResponse = Response;
+export type UnregisterDomainRegisterResponse = Response;
 export interface ListDomainsResponse extends Response {
     data: {
         domainNames: string[];

package/dist/bulkcharge/bulkcharge.js

@@ -1,50 +1,29 @@
 "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.BulkCharge = void 0;
 class BulkCharge {
     constructor(http) {
         this.http = http;
     }
-    initiate(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/bulkcharge', JSON.stringify(data));
-        });
+    async initiate(data) {
+        return await this.http.post('/bulkcharge', JSON.stringify(data));
     }
-    list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get('/bulkcharge', { params: Object.assign({}, queryParams) });
-        });
+    async list(queryParams) {
+        return await this.http.get('/bulkcharge', { params: { ...queryParams } });
     }
-    fetchBulkCharge(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get(`/bulkcharge/${id}`);
-        });
+    async fetchBulkCharge(id) {
+        return await this.http.get(`/bulkcharge/${id}`);
     }
-    fetchBatchChrges(id, queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get(`/bulkcharge/${id}/charges`, {
-                params: Object.assign({}, queryParams),
-            });
+    async fetchBatchChrges(id, queryParams) {
+        return await this.http.get(`/bulkcharge/${id}/charges`, {
+            params: { ...queryParams },
         });
     }
-    pause(batchCode) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get(`/bulkcharge/pause/${batchCode}`);
-        });
+    async pause(batchCode) {
+        return await this.http.get(`/bulkcharge/pause/${batchCode}`);
     }
-    resume(batchCode) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get(`/bulkcharge/resume/${batchCode}`);
-        });
+    async resume(batchCode) {
+        return await this.http.get(`/bulkcharge/resume/${batchCode}`);
     }
 }
 exports.BulkCharge = BulkCharge;

package/dist/charge/charge.js

@@ -1,54 +1,31 @@
 "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.Charge = void 0;
 class Charge {
     constructor(http) {
         this.http = http;
     }
-    create(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/charge', JSON.stringify(data));
-        });
+    async create(data) {
+        return await this.http.post('/charge', JSON.stringify(data));
     }
-    submitPIN(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/charge/submit_pin', JSON.stringify(data));
-        });
+    async submitPIN(data) {
+        return await this.http.post('/charge/submit_pin', JSON.stringify(data));
     }
-    submitOTP(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/charge/submit_otp', JSON.stringify(data));
-        });
+    async submitOTP(data) {
+        return await this.http.post('/charge/submit_otp', JSON.stringify(data));
     }
-    submitPhone(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/charge/submit_phone', JSON.stringify(data));
-        });
+    async submitPhone(data) {
+        return await this.http.post('/charge/submit_phone', JSON.stringify(data));
     }
-    submitBirthday(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/charge/submit_birthday', JSON.stringify(data));
-        });
+    async submitBirthday(data) {
+        return await this.http.post('/charge/submit_birthday', JSON.stringify(data));
     }
-    submitAddress(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/charge/submit_address', JSON.stringify(data));
-        });
+    async submitAddress(data) {
+        return await this.http.post('/charge/submit_address', JSON.stringify(data));
     }
-    checkPending(reference) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get('/charge/submit_address', {
-                params: { reference },
-            });
+    async checkPending(reference) {
+        return await this.http.get('/charge/submit_address', {
+            params: { reference },
         });
     }
 }

package/dist/customer/customer.js

@@ -1,13 +1,4 @@
 "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.Customer = void 0;
 /**
@@ -24,20 +15,16 @@ class Customer {
      * Create a customer on your integration
      * @param {CreateCustomer} data
      */
-    create(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/customer', JSON.stringify(data));
-        });
+    async create(data) {
+        return await this.http.post('/customer', JSON.stringify(data));
     }
     /**
      * ## List Customers
      * List customers available on your integration
      */
-    list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get('/customer', {
-                params: Object.assign({}, queryParams),
-            });
+    async list(queryParams) {
+        return await this.http.get('/customer', {
+            params: { ...queryParams },
         });
     }
     /**
@@ -45,46 +32,36 @@ class Customer {
      * Get details of a customer on your integration
      * @param {String} email_or_code
      */
-    fetch(emailCode) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get(`/customer/${emailCode}`);
-        });
+    async fetch(emailCode) {
+        return await this.http.get(`/customer/${emailCode}`);
     }
     /**
      * ## Update CUstomer
      * Update a customer's details on your integration
      */
-    update(code, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.put(`/customer/${code}`, JSON.stringify(data));
-        });
+    async update(code, data) {
+        return await this.http.put(`/customer/${code}`, JSON.stringify(data));
     }
     /**
      * ## Validate Customer
      * Validate a customer's identity
      */
-    validate(customerCode, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post(`/customer/${customerCode}/identification`, JSON.stringify(data));
-        });
+    async validate(customerCode, data) {
+        return await this.http.post(`/customer/${customerCode}/identification`, JSON.stringify(data));
     }
     /**
      * ## Whitelist/Blacklist Customer
      * Whitelist or black a customer on your integration
      */
-    setRiskAction(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/customer/set_risk_action', JSON.stringify(data));
-        });
+    async setRiskAction(data) {
+        return await this.http.post('/customer/set_risk_action', JSON.stringify(data));
     }
     /**
      * ## Deactivate Authorization
      * Deactivate an authorization when the card needs to be forgotten
      */
-    deactivateAutorization(authorizationCode) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.post('/customer/deactivate_authorization', JSON.stringify({ authorizaion_code: authorizationCode }));
-        });
+    async deactivateAutorization(authorizationCode) {
+        return await this.http.post('/customer/deactivate_authorization', JSON.stringify({ authorizaion_code: authorizationCode }));
     }
 }
 exports.Customer = Customer;

package/dist/dedicated/dedicated.js

@@ -1,57 +1,34 @@
 "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));
-        });
+    async create(data) {
+        return await 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),
-            });
+    async list(queryParams) {
+        return await this.http.get('/dedicated_account', {
+            params: { ...queryParams },
         });
     }
-    fetch(dedicatedAccountId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.get(`/dedicated_account/${dedicatedAccountId}`);
-        });
+    async fetch(dedicatedAccountId) {
+        return await this.http.get(`/dedicated_account/${dedicatedAccountId}`);
     }
-    deactivate(dedicatedAccountId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.http.delete(`/dedicated_account/${dedicatedAccountId}`);
-        });
+    async deactivate(dedicatedAccountId) {
+        return await 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));
-        });
+    async splitTransaction(data) {
+        return await 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 },
-            });
+    async removeSplit(accountNumber) {
+        return await 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');
-        });
+    async providers() {
+        return await this.http.get('/dedicated_account/available_providers');
     }
 }
 exports.DedicatedAccount = DedicatedAccount;

package/dist/interface.d.ts

@@ -42,4 +42,4 @@ export interface QueryParams {
  * For example, if a customer is supposed to make a payment of NGN 100,
  * you would send 10000 = 100 * 100 in your request.
  */
-export declare type Currency = 'NGN' | 'USD' | 'GHS' | 'ZAR' | 'KES';
+export type Currency = 'NGN' | 'USD' | 'GHS' | 'ZAR' | 'KES';

package/dist/invoice/interface.d.ts

@@ -67,7 +67,7 @@ export interface InvoiceQueryParams extends QueryParams {
     /** Show archived invoices */
     include_archive?: string;
 }
-export declare type UpdateInvoice = CreateInvoice;
+export type UpdateInvoice = CreateInvoice;
 interface InvoiceLineItem {
     name: string;
     amount: number;

package/dist/invoice/invoice.js

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

package/dist/misc/interface.d.ts

@@ -0,0 +1,109 @@
+import { Response } from '../interface';
+export type Bank = {
+    name: string;
+    slug: string;
+    code: string;
+    longcode: string;
+    gateway?: string;
+    pay_with_bank: boolean;
+    active: boolean;
+    is_deleted: boolean;
+    country: string;
+    currency: string;
+    type: string;
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type RelationshipType = 'currency' | 'integration_feature' | 'integration_type' | 'payment_method';
+type Relationship = {
+    [K in RelationshipType]: {
+        type: K;
+        data: string[];
+    };
+};
+export type Country = {
+    id: number;
+    name: string;
+    iso_code: string;
+    default_currency_code: string;
+    integration_defaults: Record<string, any>;
+    relationships: Relationship;
+};
+export type State = {
+    name: string;
+    slug: string;
+    abbreviation: string;
+};
+export type ListBanksQueryParams = {
+    /**
+     * The country from which to obtain the list of supported banks.
+     * Accepted values are: `ghana`, `kenya`, `nigeria`, `south africa`
+     */
+    country?: string;
+    /**
+     * Flag to enable cursor pagination on the endpoint
+     */
+    use_cursor?: boolean;
+    /**
+     * The number of objects to return per page.
+     * Defaults to `50`, and limited to `100` records per page.
+     */
+    perPage?: number;
+    /**
+     * A flag to filter for available banks a customer can make
+     * a transfer to complete a payment
+     */
+    pay_with_bank_transfer?: boolean;
+    /**
+     * A flag to filter for banks a customer can pay directly from
+     */
+    pay_with_bank?: boolean;
+    /**
+     * A flag to filter the banks that are supported for account
+     * verification in South Africa. You need to combine this with
+     * either the currency or country filter.
+     */
+    enabled_for_verification?: boolean;
+    /**
+     * A cursor that indicates your place in the list.
+     * It can be used to fetch the next page of the list
+     */
+    next?: string;
+    /**
+     * A cursor that indicates your place in the list.
+     * It should be used to fetch the previous page of the list
+     * after an initial next request
+     */
+    previous?: string;
+    /**
+     * The gateway type of the bank.
+     * It can be one of these: `['emandate', 'digitalbankmandate']`
+     */
+    gateway?: string;
+    /**
+     * Type of financial channel.
+     * For Ghanaian channels, please use either **mobile_money** for
+     * mobile money channels OR **ghipps** for bank channels
+     */
+    type?: string;
+    /**
+     * One of the [supported currency](https://paystack.com/docs/api/#supported-currency)
+     */
+    currency?: string;
+    /**
+     * A flag that returns Nigerian banks with their nip institution code.
+     * The returned value can be used in identifying institutions on NIP.
+     */
+    include_nip_sort_code?: string;
+};
+export interface BanksResponse extends Response {
+    data: Bank[];
+}
+export interface CountriesResponse extends Response {
+    data: Country[];
+}
+export interface StatesResponse extends Response {
+    data: State[];
+}
+export {};

package/dist/misc/interface.js

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

package/dist/misc/misc.d.ts

@@ -0,0 +1,10 @@
+import { Axios } from 'axios';
+import { BadRequest } from '../interface';
+import { BanksResponse, CountriesResponse, ListBanksQueryParams, StatesResponse } from './interface';
+export declare class Misc {
+    private http;
+    constructor(http: Axios);
+    banks(query?: ListBanksQueryParams): Promise<BanksResponse | BadRequest>;
+    countries(): Promise<CountriesResponse | BadRequest>;
+    states(country?: string): Promise<StatesResponse | BadRequest>;
+}

package/dist/misc/misc.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Misc = void 0;
+class Misc {
+    constructor(http) {
+        this.http = http;
+    }
+    async banks(query) {
+        return await this.http.get('/bank', { params: { ...query } });
+    }
+    async countries() {
+        return await this.http.get('/country');
+    }
+    async states(country) {
+        const query = country ? { country } : {};
+        return await this.http.get('/address_verification/states', {
+            params: query,
+        });
+    }
+}
+exports.Misc = Misc;