paystack-sdk 1.0.15 → 1.0.19

package/dist/customer/interface.d.ts

@@ -0,0 +1,215 @@
+import { Authorization } from '../charge';
+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>;
+}
+export interface Response {
+    status: boolean;
+    message: string;
+}
+export interface CustomerCreated extends Response {
+    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 {
+    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 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 {
+    /**
+     * 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 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/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/interface.d.ts

@@ -0,0 +1,7 @@
+export interface Meta {
+    total: number;
+    skipped: number;
+    perPage: number;
+    page: number;
+    pageCount: number;
+}

package/dist/interface.js

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

package/dist/paystack.d.ts

@@ -1,15 +1,23 @@
 import { Charge } from './charge';
+import { Customer } from './customer';
 import { Plan } from './plan';
+import { Product } from './product/product';
+import { Subscription } from './subscription/subscription';
 import { Transaction } from './transaction';
+import { Transfer } from './transfer/transfer';
 /**
  * Paystack SDK
- * @author Asaju Enitan <@en1tan>
+ * @author Asaju Enitan <@tPriest>
  */
 export declare class Paystack {
     readonly key: string;
     private readonly http;
     charge: Charge;
-    transaction: Transaction;
+    customer: Customer;
     plan: Plan;
+    product: Product;
+    subscription: Subscription;
+    transaction: Transaction;
+    transfer: Transfer;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -3,11 +3,15 @@ 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");
 const plan_1 = require("./plan");
+const product_1 = require("./product/product");
+const subscription_1 = require("./subscription/subscription");
 const transaction_1 = require("./transaction");
+const transfer_1 = require("./transfer/transfer");
 /**
  * Paystack SDK
- * @author Asaju Enitan <@en1tan>
+ * @author Asaju Enitan <@tPriest>
  */
 class Paystack {
     constructor(key) {
@@ -16,11 +20,17 @@ class Paystack {
             baseURL: 'https://api.paystack.co',
             headers: {
                 Authorization: `Bearer ${this.key}`,
+                'Content-Type': 'application/json',
             },
         });
+        this.http.interceptors.response.use((response) => (response.data = JSON.parse(response.data)));
         this.charge = new charge_1.Charge(this.http);
-        this.transaction = new transaction_1.Transaction(this.http);
+        this.customer = new customer_1.Customer(this.http);
         this.plan = new plan_1.Plan(this.http);
+        this.product = new product_1.Product(this.http);
+        this.subscription = new subscription_1.Subscription(this.http);
+        this.transaction = new transaction_1.Transaction(this.http);
+        this.transfer = new transfer_1.Transfer(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/plan/interface.d.ts

@@ -1,5 +1,5 @@
-import { Authorization } from '../charge';
-import { Meta } from '../transaction/interface';
+import { Meta } from '../interface';
+import { Subscription } from '../subscription/interface';
 export interface CreatePlan {
     /**
      * Name of plan
@@ -54,12 +54,12 @@ interface PlanCreated {
     integration: number;
     domain: string;
     plan_code: string;
-    description: any;
+    description: unknown;
     send_invoices: boolean;
     send_sms: boolean;
     hosted_page: boolean;
-    hosted_page_url: any;
-    hosted_page_summary: any;
+    hosted_page_url: unknown;
+    hosted_page_summary: unknown;
     currency: string;
     migrate: boolean;
     is_archived: boolean;
@@ -75,33 +75,11 @@ interface Plan extends PlanCreated {
     subscriptions_count: number;
     active_subscriptions_count: number;
     total_revenue: number;
-    subscribers: Subscribers[];
+    subscribers: unknown[];
 }
 interface Plans extends PlanCreated {
     subscriptions: Subscription[];
 }
-interface Subscribers {
-}
-interface Subscription {
-    customer: number;
-    plan: number;
-    integration: number;
-    domain: string;
-    start: number;
-    status: string;
-    quantity: number;
-    amount: number;
-    subscription_code: string;
-    email_token: string;
-    authorization: Authorization;
-    easy_cron_id: any;
-    cron_expression: string;
-    next_payment_date: Date;
-    open_invoice: any;
-    id: number;
-    createdAt: Date;
-    updatedAt: Date;
-}
 export interface ListPlanQueryParams {
     /**
      * Specify how many records you want to retrieve per page.
@@ -169,4 +147,24 @@ export interface UpdatePlan {
      */
     invoice_limit?: number;
 }
+export interface IPlan {
+    domain: string;
+    name: string;
+    plan_code: string;
+    description: string;
+    amount: number;
+    interval: string;
+    send_invoices: boolean;
+    send_sms: boolean;
+    hosted_page: boolean;
+    hosted_page_url: string;
+    hosted_page_summary: string;
+    currency: string;
+    migrate: boolean;
+    id: number;
+    integration: number;
+    is_archived: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
 export {};

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/product/index.js

@@ -0,0 +1 @@
+"use strict";

package/dist/product/interface.d.ts

@@ -0,0 +1,87 @@
+import { Meta } from '../interface';
+export interface CreateProduct {
+    /** Name of product */
+    name: string;
+    /** A description for this product */
+    description: string;
+    /**
+     * Price should be in *kobo* if currency is `NGN`,
+     * *pesewas*, if currency is `GHS`, and *cents*, if currency is `ZAR`
+     */
+    price: number;
+    /** Currency in which price is set. Allowed values are: NGN, GHS, ZAR or USD */
+    currency: string;
+    /**
+     * Set to `true` if the product has unlimited stock. Leave as `false` if the product has limited stock
+     */
+    unlimited?: boolean;
+    /** Number of products in stock. Use if `unlimited` is `false` */
+    quantity?: number;
+}
+export interface Response {
+    status: boolean;
+    message: string;
+}
+export interface ProductCreated extends Response {
+    data: Product;
+}
+export interface ListProducts extends Response {
+    data: Product[];
+    meta: Meta;
+}
+export interface FetchProduct extends Response {
+    data: Product;
+}
+export interface UpdateProduct extends Response {
+    data: Product;
+}
+export interface ListProductQueryParams {
+    /**
+     * 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 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;
+}
+interface Product {
+    id: number;
+    name: string;
+    description: string;
+    currency: string;
+    price: number;
+    quantity: number;
+    image_path: string;
+    file_path: string;
+    is_shippable: boolean;
+    unlimited: boolean;
+    integration: number;
+    domain: string;
+    metadata: Record<string, unknown>;
+    slug: string;
+    product_code: string;
+    quantity_sold: number;
+    type: string;
+    shipping_fields: Record<string, unknown>;
+    active: boolean;
+    in_stock: boolean;
+    minimum_orderable: number;
+    maximum_orderable: number;
+    low_stock_alert: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export {};

package/dist/product/interface.js

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

package/dist/product/product.d.ts

@@ -0,0 +1,21 @@
+import { Axios } from 'axios';
+import { CreateProduct, FetchProduct, ListProductQueryParams, ListProducts, ProductCreated, UpdateProduct } from './interface';
+interface BadRequest {
+    status: boolean;
+    message: string;
+}
+/**
+ * @class Product
+ * # Producs
+ * The products API allows you create and manage inventories
+ * on your integration
+ */
+export declare class Product {
+    http: Axios;
+    constructor(http: Axios);
+    create(data: CreateProduct): Promise<ProductCreated | BadRequest>;
+    list(queryParams?: ListProductQueryParams): Promise<ListProducts | BadRequest>;
+    fetch(id: string): Promise<FetchProduct | BadRequest>;
+    update(id: string, data: CreateProduct): Promise<UpdateProduct | BadRequest>;
+}
+export {};

package/dist/product/product.js

@@ -0,0 +1,46 @@
+"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.Product = void 0;
+/**
+ * @class Product
+ * # Producs
+ * The products API allows you create and manage inventories
+ * on your integration
+ */
+class Product {
+    constructor(http) {
+        this.http = http;
+    }
+    create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/product', JSON.stringify(data));
+        });
+    }
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/product', {
+                params: Object.assign({}, queryParams),
+            });
+        });
+    }
+    fetch(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/product/${id}`);
+        });
+    }
+    update(id, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.put(`/product/${id}`, JSON.stringify(data));
+        });
+    }
+}
+exports.Product = Product;

package/dist/subscription/index.d.ts

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

package/dist/subscription/index.js

@@ -0,0 +1,13 @@
+"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);