paystack-sdk 1.0.14 → 1.0.18

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/customer/customer.d.ts

@@ -0,0 +1,60 @@
+import { Axios } from 'axios';
+import { Meta } from '../transaction';
+import { CreateCustomer, CustomerCreated, CustomerData, ListCustomerQueryParams, ListCustomers, Response, 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<(Response & ListCustomers[] & Meta) | 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,102 @@
+"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* () {
+            const response = yield this.http.post('/customer', JSON.stringify(data));
+            return JSON.parse(response.data);
+        });
+    }
+    /**
+     * ## List Customers
+     * List customers available on your integration
+     * @param {ListCustomerQueryParams} queryParams
+     */
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.http.get('/customer', {
+                params: Object.assign({}, queryParams),
+            });
+            return JSON.parse(response.data);
+        });
+    }
+    /**
+     * ## 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* () {
+            const response = yield this.http.get(`/customer/${emailCode}`);
+            return JSON.parse(response.data);
+        });
+    }
+    /**
+     * ## Update CUstomer
+     * Update a customer's details on your integration
+     */
+    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);
+        });
+    }
+    /**
+     * ## 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* () {
+            const response = yield this.http.post(`/customer/${customerCode}/identification`, JSON.stringify(data));
+            return JSON.parse(response.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* () {
+            const response = yield this.http.post('/customer/set_risk_action', JSON.stringify(data));
+            return JSON.parse(response.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 JSON.parse(response.data);
+        });
+    }
+}
+exports.Customer = Customer;

package/dist/customer/interface.d.ts

@@ -0,0 +1,177 @@
+import { Authorization } from '../charge';
+import { Subscription, TransactionData } from '../transaction';
+export interface CreateCustomer {
+    email: string;
+    first_name: string;
+    last_name: string;
+    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;
+}
+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;
+}
+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 ListCustomerQueryParams {
+    /**
+     * 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;
+    /**
+     * Specify an ID for the customer whose transactions
+     * you want to retrieve
+     */
+    customer?: number;
+    /**
+     * Filter transactions by status ('failed', 'success', 'abandoned')
+     */
+    status?: string;
+    /**
+     * A timestamp from which to start listing transaction
+     * e.g `2021-10-25T00.00.05.000z`, `2021-12-25`
+     */
+    from?: Date;
+    /**
+     * A timestamp from which to stop listing transaction
+     * e.g `2021-10-25T00.00.05.000z`, `2021-12-25`
+     */
+    to?: Date;
+}
+export interface SplitConfig {
+    id: number;
+    name: string;
+    type: string;
+    currency: string;
+    integration: number;
+    domain: string;
+    split_code: string;
+    active: boolean;
+    bearer_type: string;
+    bearer_subaccount: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+    is_dynamic: boolean;
+    subaccounts: SubAccount[];
+    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;
+    };
+    share: number;
+}
+export interface CustomerIdentification {
+    country: string;
+    type: string;
+    value: string;
+}
+export interface DedicatedAccount {
+    bank: {
+        name: string;
+        id: number;
+        slug: string;
+    };
+    id: number;
+    account_name: string;
+    account_number: string;
+    created_at: Date;
+    updated_at: Date;
+    currency: string;
+    split_config: SplitConfig;
+    active: boolean;
+    assigned: boolean;
+    assignment: {
+        assignee_id: number;
+        assignee_type: string;
+        account_type: string;
+        integration: number;
+    };
+}
+export interface UpdateCustomer {
+    first_name: string;
+    last_name: string;
+    phone: string;
+    metadata: Record<string, any>;
+}
+export interface SetRiskAction {
+    customer: string;
+    risk_action: RiskAction;
+}
+export interface ValidateCustomer {
+    first_name: string;
+    last_name: string;
+    type: ValidationType;
+    value: string;
+    country: string;
+    bvn: string;
+    bank_code: string;
+    account_number: string;
+}
+declare enum RiskAction {
+    default = 0,
+    allow = 1,
+    deny = 2
+}
+declare enum ValidationType {
+    bvn = 0,
+    bank_account = 1
+}
+export {};

package/dist/customer/interface.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var RiskAction;
+(function (RiskAction) {
+    RiskAction[RiskAction["default"] = 0] = "default";
+    RiskAction[RiskAction["allow"] = 1] = "allow";
+    RiskAction[RiskAction["deny"] = 2] = "deny";
+})(RiskAction || (RiskAction = {}));
+var ValidationType;
+(function (ValidationType) {
+    ValidationType[ValidationType["bvn"] = 0] = "bvn";
+    ValidationType[ValidationType["bank_account"] = 1] = "bank_account";
+})(ValidationType || (ValidationType = {}));

package/dist/index.d.ts

@@ -1 +1 @@
-export {};
+export { Paystack } from './paystack';

package/dist/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const paystack_1 = require("./paystack");
-exports = paystack_1.Paystack;
+exports.Paystack = void 0;
+var paystack_1 = require("./paystack");
+Object.defineProperty(exports, "Paystack", { enumerable: true, get: function () { return paystack_1.Paystack; } });

package/dist/paystack.d.ts

@@ -1,4 +1,5 @@
 import { Charge } from './charge';
+import { Customer } from './customer/customer';
 import { Plan } from './plan';
 import { Transaction } from './transaction';
 /**
@@ -11,5 +12,6 @@ export declare class Paystack {
     charge: Charge;
     transaction: Transaction;
     plan: Plan;
+    customer: Customer;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Paystack = void 0;
 const axios_1 = require("axios");
 const charge_1 = require("./charge");
+const customer_1 = require("./customer/customer");
 const plan_1 = require("./plan");
 const transaction_1 = require("./transaction");
 /**
@@ -21,6 +22,7 @@ class Paystack {
         this.charge = new charge_1.Charge(this.http);
         this.transaction = new transaction_1.Transaction(this.http);
         this.plan = new plan_1.Plan(this.http);
+        this.customer = new customer_1.Customer(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/plan/plan.js

@@ -28,8 +28,8 @@ class Plan {
      */
     create(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.http.post('/plan', data);
-            return response.data;
+            const response = yield this.http.post('/plan', JSON.stringify(data));
+            return JSON.parse(response.data);
         });
     }
     /**

package/dist/transaction/interface.d.ts

@@ -83,7 +83,7 @@ interface TransactionInitializedOk {
     access_code: string;
     reference: string;
 }
-interface TransactionData {
+export interface TransactionData {
     amount: number;
     currency: string;
     transaction_date: Date;
@@ -92,7 +92,7 @@ interface TransactionData {
     domain: string;
     metadata: number;
     gateway_response: string;
-    message?: null;
+    message?: any;
     channel: string;
     ip_address: string;
     log: {
@@ -292,4 +292,6 @@ export interface PartialDebit {
      */
     at_least: string;
 }
+export interface Subscription {
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "1.0.14",
+  "version": "1.0.18",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Koderant",