paystack-sdk 1.0.15 → 1.0.19

package/README.md

@@ -1,9 +1,11 @@
 # Paystack SDK
 
 #### Why Another [Paystack](https://paystack.com) Package?
+
 Other packages are either outdated or don't support types.
 
 ### Installation
+
 For Yarn
 `yarn add paystack-sdk`
 
@@ -11,7 +13,9 @@ For NPM
 `npm install paystack-sdk`
 
 ### Usage
+
 For Typescript
+
 ```
 import Paystack from 'paystack-sdk';
 
@@ -19,6 +23,7 @@ const paystack = new Paystack("secret_key);
 ```
 
 For Javscript
+
 ```
 const Paystack = require('paystack-sdk');
 const paystack = new Paystack("secret_key");
@@ -26,7 +31,9 @@ const paystack = new Paystack("secret_key");
 
 All methods use promise meaning you can either use the `async...await` or `then...catch` or `try...catch`
 
-### Available Docs
+### 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)

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;

package/dist/customer/customer.d.ts

@@ -0,0 +1,60 @@
+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;
+}
+/**
+ * # Customers
+ * The Customers API allows you create and manage
+ * customers on your integration
+ */
+export declare class Customer {
+    private http;
+    constructor(http: Axios);
+    /**
+     * ## Create Customer
+     * Create a customer on your integration
+     * @param {CreateCustomer} data
+     */
+    create(data: CreateCustomer): Promise<CustomerCreated | BadRequest>;
+    /**
+     * ## List Customers
+     * List customers available on your integration
+     * @param {ListCustomerQueryParams} queryParams
+     */
+    list(queryParams?: ListCustomerQueryParams): Promise<ListCustomersResponse | BadRequest>;
+    /**
+     * ## Fetch Customer
+     * Get details of a customer on your integration
+     * @param {String} email_or_code
+     */
+    fetch(emailCode: string): Promise<CustomerData | BadRequest>;
+    /**
+     * ## Update CUstomer
+     * Update a customer's details on your integration
+     */
+    update(code: string, data: UpdateCustomer): Promise<CustomerData | 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>;
+    /**
+     * ## 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

@@ -0,0 +1,96 @@
+"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;
+/**
+ * # Customers
+ * The Customers API allows you create and manage
+ * customers on your integration
+ */
+class Customer {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * ## Create 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));
+        });
+    }
+    /**
+     * ## List Customers
+     * List customers available on your integration
+     * @param {ListCustomerQueryParams} queryParams
+     */
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/customer', {
+                params: Object.assign({}, queryParams),
+            });
+        });
+    }
+    /**
+     * ## Fetch 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}`);
+        });
+    }
+    /**
+     * ## 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));
+        });
+    }
+    /**
+     * ## 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* () {
+            return yield this.http.post(`/customer/${customerCode}/identification`, JSON.stringify(data));
+        });
+    }
+    /**
+     * ## Whitelist/Blacklist Customer
+     * Whitelist or black a customer on your integration
+     * @param {SetRiskAction} data
+     */
+    setRiskAction(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/customer/set_risk_action', JSON.stringify(data));
+        });
+    }
+    /**
+     * ## 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;
+        });
+    }
+}
+exports.Customer = Customer;

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);