paystack-sdk 1.0.18 → 1.1.20

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,10 @@ 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

package/dist/charge/charge.d.ts

@@ -1,28 +1,18 @@
 import { Axios } from 'axios';
-import { ChargeCreated, CreateCharge, SubmitAddress, SubmitBirthday, SubmitOTP, SubmitPhone, SubmitPIN } from '.';
+import { ChargeCreated, ChargeCreatedResponse, CreateCharge, SubmitAddress, SubmitBirthday, SubmitOTP, SubmitPhone, SubmitPIN } from './interface';
 interface BadRequest {
     status: boolean;
     message: string;
-    data: null;
 }
-export interface ICharge {
-    create(data: CreateCharge): Promise<ChargeCreated | BadRequest>;
-    submitPIN(data: SubmitPIN): Promise<ChargeCreated | BadRequest>;
-    submitOTP(data: SubmitOTP): Promise<ChargeCreated | BadRequest>;
-    submitPhone(data: SubmitPhone): Promise<ChargeCreated | BadRequest>;
-    submitBirthday(data: SubmitBirthday): Promise<ChargeCreated | BadRequest>;
-    submitAddress(data: SubmitAddress): Promise<ChargeCreated | BadRequest>;
-    checkPending(reference: string): Promise<ChargeCreated | BadRequest>;
-}
-export declare class Charge implements ICharge {
+export declare class Charge {
     private http;
     constructor(http: Axios);
-    create(data: CreateCharge): Promise<ChargeCreated | BadRequest>;
+    create(data: CreateCharge): Promise<ChargeCreatedResponse | BadRequest>;
     submitPIN(data: SubmitPIN): Promise<ChargeCreated | BadRequest>;
-    submitOTP(data: SubmitOTP): Promise<ChargeCreated | BadRequest>;
-    submitPhone(data: SubmitPhone): Promise<ChargeCreated | BadRequest>;
-    submitBirthday(data: SubmitBirthday): Promise<ChargeCreated | BadRequest>;
-    submitAddress(data: SubmitAddress): Promise<ChargeCreated | BadRequest>;
-    checkPending(reference: string): Promise<ChargeCreated | BadRequest>;
+    submitOTP(data: SubmitOTP): Promise<ChargeCreatedResponse | BadRequest>;
+    submitPhone(data: SubmitPhone): Promise<ChargeCreatedResponse | BadRequest>;
+    submitBirthday(data: SubmitBirthday): Promise<ChargeCreatedResponse | BadRequest>;
+    submitAddress(data: SubmitAddress): Promise<ChargeCreatedResponse | BadRequest>;
+    checkPending(reference: string): Promise<ChargeCreatedResponse | BadRequest>;
 }
 export {};

package/dist/charge/charge.js

@@ -16,46 +16,39 @@ class Charge {
     }
     create(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/charge', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/charge', JSON.stringify(data));
         });
     }
     submitPIN(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/charge/submit_pin', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/charge/submit_pin', JSON.stringify(data));
         });
     }
     submitOTP(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/charge/submit_otp', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/charge/submit_otp', JSON.stringify(data));
         });
     }
     submitPhone(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/charge/submit_phone', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/charge/submit_phone', JSON.stringify(data));
         });
     }
     submitBirthday(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/charge/submit_birthday', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/charge/submit_birthday', JSON.stringify(data));
         });
     }
     submitAddress(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/charge/submit_address', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/charge/submit_address', JSON.stringify(data));
         });
     }
     checkPending(reference) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.get('/charge/submit_address', {
+            return yield this.http.get('/charge/submit_address', {
                 params: { reference },
             });
-            return JSON.parse(response.data);
         });
     }
 }

package/dist/charge/interface.d.ts

@@ -1,3 +1,5 @@
+import { Response } from '../transaction';
+export declare type ChargeCreatedResponse = ChargeCreated | ChargeCreatedWithOTP | ChargeCreatedWithPending | ChargeCreatedWithAddress | ChargeCreatedWithBankAuth | ChargeCreatedWithPin | ChargeCreatedWithPhone | ChargeCreatedWithBirthday | ChargeCreatedWithUSSD | ChargeCreatedWithMobileMoney | ChargeFailed;
 export interface CreateCharge {
     email: string;
     amount: string;
@@ -14,106 +16,132 @@ export interface CreateCharge {
     device_id?: string;
     birthday?: string;
 }
-export interface Submit {
+export interface SubmitPIN {
     reference: string;
-}
-export interface SubmitPIN extends Submit {
     pin: string;
 }
-export interface SubmitOTP extends Submit {
+export interface SubmitOTP {
+    reference: string;
     otp: string;
 }
-export interface SubmitPhone extends Submit {
+export interface SubmitPhone {
+    reference: string;
     phone: string;
 }
-export interface SubmitBirthday extends Submit {
+export interface SubmitBirthday {
+    reference: string;
     birthday: Date;
 }
-export interface SubmitAddress extends Submit {
+export interface SubmitAddress {
+    reference: string;
     address: string;
     city: string;
     state: string;
     zip_code: string;
 }
-export interface ChargeCreated {
-    status: boolean;
-    message: string;
-    data: ChargeCreatedOk | ChargeCreatedResponseWithAddress | ChargeCreatedResponseWithPending | ChargeCreatedResponseWithBankAuth | ChargeCreatedResponseWithMobileMoney | ChargeCreatedResponseWithUSSD | ChargeCreatedResponseWithOTP | ChargeCreatedResponseWithPin | ChargeCreatedResponseWithPhone | ChargeFailed;
+export interface ChargeCreated extends Response {
+    data: {
+        amount: number;
+        currency: string;
+        transaction_date: string;
+        status: string;
+        reference: string;
+        domain: string;
+        metadata: Record<string, unknown>;
+        gateway_response: string;
+        message: string;
+        channel: string;
+        ip_address: string;
+        log: unknown;
+        fees: number;
+        authorization: Authorization;
+        customer: Customer;
+        display_text: string;
+        plan: unknown;
+    };
 }
-interface ChargeCreatedOk {
-    amount: number;
-    currency: string;
-    transaction_date: string;
-    status: string;
-    reference: string;
-    domain: string;
-    metadata: Record<string, unknown>;
-    gateway_response: string;
-    message: string;
-    channel: string;
-    ip_address: string;
-    log: any | null;
-    fees: number;
-    authorization: Authorization;
-    customer: Customer;
-    display_text: string;
-    plan: string | null;
-}
-interface ChargeCreatedResponseWithPending {
-    reference: string;
-    status: string;
+interface ChargeCreatedWithPending extends Response {
+    data: {
+        reference: string;
+        status: string;
+    };
 }
-interface ChargeCreatedResponseWithAddress {
-    display_text: string;
-    reference: string;
-    status: string;
-    country_code: string;
+interface ChargeCreatedWithAddress extends Response {
+    data: {
+        display_text: string;
+        reference: string;
+        status: string;
+        country_code: string;
+    };
 }
-interface ChargeCreatedResponseWithMobileMoney {
-    amount: number;
-    channel: string;
-    created_at: Date;
-    currency: string;
-    domain: string;
-    fees: number;
-    gateway_response: string;
-    id: number;
-    ip_address: string;
-    message: string;
-    paid_at: Date;
-    reference: string;
-    status: string;
-    transaction_date: Date;
-    authorization: Authorization;
-    customer: Customer;
+interface ChargeCreatedWithMobileMoney extends Response {
+    data: {
+        amount: number;
+        channel: string;
+        created_at: Date;
+        currency: string;
+        domain: string;
+        fees: number;
+        gateway_response: string;
+        id: number;
+        ip_address: string;
+        message: string;
+        paid_at: Date;
+        reference: string;
+        status: string;
+        transaction_date: Date;
+        authorization: Authorization;
+        customer: Customer;
+    };
 }
-interface ChargeCreatedResponseWithUSSD {
-    reference: string;
-    status: string;
-    display_text: string;
-    ussd_code: string;
+interface ChargeCreatedWithUSSD extends Response {
+    data: {
+        reference: string;
+        status: string;
+        display_text: string;
+        ussd_code: string;
+    };
 }
-interface ChargeCreatedResponseWithBirthday {
-    reference: string;
-    status: string;
-    display_text: string;
+interface ChargeCreatedWithBirthday extends Response {
+    data: {
+        reference: string;
+        status: string;
+        display_text: string;
+    };
 }
-interface ChargeCreatedResponseWithPhone extends ChargeCreatedResponseWithBirthday {
+interface ChargeCreatedWithBankAuth extends Response {
+    data: {
+        refernce: string;
+        uri: string;
+        status: string;
+    };
 }
-interface ChargeCreatedResponseWithBankAuth {
-    refernce: string;
-    uri: string;
-    status: string;
+interface ChargeCreatedWithOTP extends Response {
+    data: {
+        refernce: string;
+        status: string;
+        display_text: string;
+    };
 }
-interface ChargeCreatedResponseWithPin extends ChargeCreatedResponseWithPending {
+interface ChargeCreatedWithPin extends Response {
+    data: {
+        refernce: string;
+        status: string;
+    };
 }
-interface ChargeCreatedResponseWithOTP extends ChargeCreatedResponseWithPending {
-    display_text: string;
+interface ChargeCreatedWithPhone extends Response {
+    data: {
+        refernce: string;
+        status: string;
+        display_text: string;
+    };
 }
-interface ChargeFailed {
-    refernce: string;
-    message: string;
-    status: string;
+interface ChargeFailed extends Response {
+    data: {
+        refernce: string;
+        message: string;
+        status: string;
+    };
 }
 export interface Authorization {
     authorization_code: string;
@@ -131,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/customer/customer.d.ts

@@ -1,6 +1,6 @@
 import { Axios } from 'axios';
-import { Meta } from '../transaction';
-import { CreateCustomer, CustomerCreated, CustomerData, ListCustomerQueryParams, ListCustomers, Response, SetRiskAction, UpdateCustomer, ValidateCustomer } from './interface';
+import { ListCustomersResponse } from '.';
+import { CreateCustomer, CustomerCreated, CustomerData, ListCustomerQueryParams, SetRiskAction, UpdateCustomer, ValidateCustomer } from './interface';
 interface BadRequest {
     status: boolean;
     message: string;
@@ -25,7 +25,7 @@ export declare class Customer {
      * List customers available on your integration
      * @param {ListCustomerQueryParams} queryParams
      */
-    list(queryParams?: ListCustomerQueryParams): Promise<(Response & ListCustomers[] & Meta) | BadRequest>;
+    list(queryParams?: ListCustomerQueryParams): Promise<ListCustomersResponse | BadRequest>;
     /**
      * ## Fetch Customer
      * Get details of a customer on your integration

package/dist/customer/customer.js

@@ -26,8 +26,7 @@ class Customer {
      */
     create(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/customer', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/customer', JSON.stringify(data));
         });
     }
     /**
@@ -37,10 +36,9 @@ class Customer {
      */
     list(queryParams) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.get('/customer', {
+            return yield this.http.get('/customer', {
                 params: Object.assign({}, queryParams),
             });
-            return JSON.parse(response.data);
         });
     }
     /**
@@ -50,8 +48,7 @@ class Customer {
      */
     fetch(emailCode) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.get(`/customer/${emailCode}`);
-            return JSON.parse(response.data);
+            return yield this.http.get(`/customer/${emailCode}`);
         });
     }
     /**
@@ -60,8 +57,7 @@ class Customer {
      */
     update(code, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.put(`/customer/${code}`, JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.put(`/customer/${code}`, JSON.stringify(data));
         });
     }
     /**
@@ -72,8 +68,7 @@ class Customer {
      */
     validate(customerCode, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post(`/customer/${customerCode}/identification`, JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post(`/customer/${customerCode}/identification`, JSON.stringify(data));
         });
     }
     /**
@@ -83,8 +78,7 @@ class Customer {
      */
     setRiskAction(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/customer/set_risk_action', JSON.stringify(data));
-            return JSON.parse(response.data);
+            return yield this.http.post('/customer/set_risk_action', JSON.stringify(data));
         });
     }
     /**
@@ -95,7 +89,7 @@ class Customer {
     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 JSON.parse(response.data);
+            return response;
         });
     }
 }

package/dist/customer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interface';
+export * from './customer';

package/dist/customer/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interface"), exports);
+__exportStar(require("./customer"), exports);

package/dist/customer/interface.d.ts

@@ -1,58 +1,77 @@
 import { Authorization } from '../charge';
-import { Subscription, TransactionData } from '../transaction';
+import { Meta } from '../interface';
+import { Subscription } from '../subscription/interface';
+import { TransactionData } from '../transaction';
 export interface CreateCustomer {
     email: string;
     first_name: string;
     last_name: string;
-    phone: string;
-    metadata: Record<string, any>;
+    phone?: string;
+    metadata?: Record<string, any>;
 }
 export interface Response {
     status: boolean;
     message: string;
 }
 export interface CustomerCreated extends Response {
-    email: string;
-    integration: number;
-    domain: string;
-    customer_code: string;
-    id: number;
-    identified: boolean;
-    identifications: null;
-    createdAt: Date;
-    updatedAt: Date;
+    data: {
+        transactions: TransactionData[];
+        subscriptions: Subscription[];
+        authorizations: Authorization[];
+        first_name: string;
+        last_name: string;
+        email: string;
+        phone: string | null;
+        metadata: Record<string, any> | null;
+        domain: string;
+        customer_code: string;
+        risk_action: string;
+        id: number;
+        integration: number;
+        createdAt: Date;
+        updatedAt: Date;
+        identified: boolean;
+        identifications: null;
+    };
 }
 export interface CustomerData extends Response {
-    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: TransactionData[];
-    subscriptions: Subscription[];
-    authorizations: Authorization[];
-    createdAt: Date;
-    updatedAt: Date;
+    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: TransactionData[];
+        subscriptions: Subscription[];
+        authorizations: Authorization[];
+        createdAt: Date;
+        updatedAt: Date;
+    };
 }
-export interface ListCustomers {
-    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;
+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;
+        }
+    ];
+    meta: Meta;
 }
 export interface ListCustomerQueryParams {
     /**
@@ -174,4 +193,23 @@ declare enum ValidationType {
     bvn = 0,
     bank_account = 1
 }
+export interface ICustomer {
+    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, unknown> | null;
+    domain: string;
+    customer_code: string;
+    id: string;
+    transactions: TransactionData[];
+    subscriptions: Subscription[];
+    authorizations: Authorization[];
+    createdAt: Date;
+    updatedAt: Date;
+}
 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 {};