paystack-sdk 1.0.9 → 1.0.13

package/dist/index.js

@@ -1,5 +1,2 @@
-// @ts-ignore
-// @ts-ignore
-import Paystack from './paystack';
-// @ts-ignore
-module.export = Paystack;
+import { Paystack } from './paystack';
+exports = Paystack;

package/dist/paystack.d.ts

@@ -1,15 +1,15 @@
-import { ICharge } from './charge';
-import { Plan } from './plan/plan';
-import { ITransaction } from './transaction/transaction';
+import { Charge } from './charge';
+import { Plan } from './plan';
+import { Transaction } from './transaction';
 /**
  * Paystack SDK
  * @author Asaju Enitan <@en1tan>
  */
-export default class Paystack {
+export declare class Paystack {
     readonly key: string;
     private readonly http;
-    charge: ICharge;
-    transaction: ITransaction;
+    charge: Charge;
+    transaction: Transaction;
     plan: Plan;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -1,12 +1,12 @@
 import { Axios } from 'axios';
 import { Charge } from './charge';
-import { Plan } from './plan/plan';
-import { Transaction } from './transaction/transaction';
+import { Plan } from './plan';
+import { Transaction } from './transaction';
 /**
  * Paystack SDK
  * @author Asaju Enitan <@en1tan>
  */
-export default class Paystack {
+export class Paystack {
     key;
     http;
     charge;
@@ -18,9 +18,7 @@ export default class Paystack {
             baseURL: 'https://api.paystack.co',
             headers: {
                 Authorization: `Bearer ${this.key}`,
-                'Content-Type': 'application/json',
             },
-            responseType: 'json',
         });
         this.charge = new Charge(this.http);
         this.transaction = new Transaction(this.http);

package/dist/plan/interface.d.ts

@@ -37,7 +37,7 @@ export interface CreatePlan {
     currency?: string;
     /**
      * Number of invoices to raise during subscription to this plan.
-     * Can be overriden by specifying an `invoice_limit` while subscribing
+     * Can be overridden by specifying an `invoice_limit` while subscribing
      */
     invoice_limit?: number;
 }

package/dist/plan/plan.d.ts

@@ -5,19 +5,13 @@ interface BadRequest {
     message: string;
     data: null;
 }
-export interface IPlan {
-    create(data: CreatePlan): Promise<PlanResponse | BadRequest>;
-    list(queryParams?: ListPlanQueryParams): Promise<PlanResponse | BadRequest>;
-    fetch(id: string): Promise<PlanResponse | BadRequest>;
-    update(id: string, data: UpdatePlan): Promise<PlanResponse | BadRequest>;
-}
 /**
  * ## Plans
  * The Plans API allows you create and manage installment
  * payment options on your integration
  * @class Plan
  */
-export declare class Plan implements IPlan {
+export declare class Plan {
     private http;
     constructor(http: Axios);
     /**

package/dist/plan/plan.js

@@ -16,8 +16,8 @@ export class Plan {
      * @returns {Promise<PlanResponse | BadRequest>}
      */
     async create(data) {
-        const response = await this.http.post('/plan', JSON.stringify(data));
-        return JSON.parse(response.data);
+        const response = await this.http.post('/plan', data);
+        return response.data;
     }
     /**
      * ### List Plans

package/dist/transaction/interface.d.ts

@@ -16,7 +16,7 @@ export interface InitializeTransaction {
      */
     currency?: string;
     /**
-     * Unique transaction reference. Only `-`,`.`,`_`
+     * Unique transaction reference. Only `-`,`.`,`=`
      * and alphanumeric characters allowed
      */
     reference?: string;
@@ -75,7 +75,7 @@ export interface InitializeTransaction {
 export interface TransactionResponse {
     status: boolean;
     message: string;
-    data: TransactionInitializedOk | TransactionData | Transactions;
+    data: TransactionInitializedOk | TransactionData | Transactions | Timeline | ExportTransaction;
     meta?: Meta;
 }
 interface TransactionInitializedOk {
@@ -118,6 +118,26 @@ interface TransactionData {
 }
 interface Transactions extends TransactionData {
 }
+interface Timeline {
+    time_spent: number;
+    attempts: number;
+    authentication: any;
+    errors: number;
+    success: boolean;
+    mobile: boolean;
+    input: [];
+    channel: string;
+    history: [
+        {
+            type: string;
+            message: string;
+            time: number;
+        }
+    ];
+}
+interface ExportTransaction {
+    path: string;
+}
 export interface ListTransactionQueryParams {
     /**
      * Specify how many records you want to retrieve per page.
@@ -142,19 +162,19 @@ export interface ListTransactionQueryParams {
      * A timestamp from which to start listing transaction
      * e.g `2021-10-25T00.00.05.000z`, `2021-12-25`
      */
-    from: Date;
+    from?: Date;
     /**
      * A timestamp from which to stop listing transaction
      * e.g `2021-10-25T00.00.05.000z`, `2021-12-25`
      */
-    to: Date;
+    to?: Date;
     /**
      * Filter transactions by amount.
      * Specify the amount (in **kobo** if currency is `NGN`,
      * **pesewas**, if currency is `GHS`,
      * and **cents**, if currency is `ZAR`)
      */
-    amount: number;
+    amount?: number;
 }
 export interface Meta {
     total: number;
@@ -163,4 +183,113 @@ export interface Meta {
     page: number;
     pageCount: number;
 }
+export interface ChargeAuthorization {
+    /**
+     * Amount should be in kobo if currency is `NGN`, *pesewas*,
+     * if currency is `GHS`, and cents, if currency is `ZAR`
+     */
+    amount: string;
+    /**
+     * Customer's email address
+     */
+    email: string;
+    /**
+     * Valid authorization code to charge
+     */
+    authorization_code: string;
+    /**
+     * Unique transaction reference. Only `-`, `.`,`=`
+     * and alphanumeric characters allowed
+     */
+    reference?: string;
+    /**
+     * Currency in which amount shoud be charged.
+     * Allowed values are: NGN,GHS,ZAR or USD
+     */
+    currency?: string;
+    /**
+     * Stringified JSON object. Add a custom_fields attribute which has
+     * an array of objects if you would like the fields to be added to your
+     * transaction when displayed on the dashboard.
+     * @example {
+     * "custom_fields": [{"display_name": "Cart ID","variable_name": "cart_id","value": "8393"}]}
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Send us 'card' or 'bank' or 'card','bank' as an array to specify what
+     * options to show the user paying
+     */
+    channels?: string[];
+    /**
+     * The code for the subaccount that owns the payment.
+     * @exmple ACCT_8f4s1eq7ml6rlzj
+     */
+    subaccount?: string;
+    /**
+     * A flat fee to charge the subaccount for this transaction (in kobo if currency is NGN,
+     * pesewas, if currency is GHS, and cents, if currency is ZAR). This overrides the split percentage
+     * set when the subaccount was created. Ideally, you will need to use this if you are splitting in
+     * flat rates (since subaccount creation only allows for
+     */
+    transaction_charge?: number;
+    /**
+     * Who bears Paystack charges? `account` or `subaccount` (defaults to `account`).
+     */
+    bearer?: string;
+    /**
+     * If you are making a scheduled charge call, it is a good idea to queue them so the processing
+     * system does not get overloaded causing transaction processing errors. Send queue:true
+     * to take advantage of our queued charging.
+     */
+    queue?: boolean;
+}
+export interface CheckAuthorization {
+    /**
+     * Amount should be in kobo if currency is `NGN`,
+     * pesewas, if currency is `GHS`, and cents, if currency is `ZAR`
+     */
+    amount: string;
+    /**
+     * Customer's email address
+     */
+    email: string;
+    /**
+     * Valid authorization code to charge
+     */
+    authorization_code: string;
+    /**
+     * Currency in which amount should be charged.
+     * Allowed values are: `NGN`, `GHS`, `ZAR` or `USD`
+     */
+    currency?: string;
+}
+export interface PartialDebit {
+    /**
+     * Authorization Code
+     */
+    authorization_code: string;
+    /**
+     * Specify the currency you want to debit.
+     * Allowed values are `NGN`, `GHS`, `ZAR` or `USD`.
+     */
+    currency: string;
+    /**
+     * Amount should be in *kobo* if currency is NGN,
+     * pesewas, if *currency* is `GHS`, and *cents*, if currency is `ZAR`
+     */
+    amount: string;
+    /**
+     * Customer's email address (attached to the authorization code)
+     */
+    email: string;
+    /**
+     * Unique transaction reference.
+     * Only `-`, `.`, `=` and alphanumeric characters allowed.
+     */
+    reference: string;
+    /**
+     * Minimum amount to charge
+     */
+    at_least: string;
+}
 export {};

package/dist/transaction/transaction.d.ts

@@ -1,21 +1,16 @@
 import { Axios } from 'axios';
-import { InitializeTransaction, ListTransactionQueryParams, TransactionResponse } from './interface';
+import { ChargeAuthorization, CheckAuthorization, InitializeTransaction, ListTransactionQueryParams, PartialDebit, TransactionResponse } from './interface';
 interface BadRequest {
     status: boolean;
     message: string;
     data: null;
 }
-export interface ITransaction {
-    initialize(data: InitializeTransaction): Promise<TransactionResponse | BadRequest>;
-    verify(reference: string): Promise<TransactionResponse | BadRequest>;
-    list(queryParams: ListTransactionQueryParams): Promise<TransactionResponse | BadRequest>;
-}
 /**
- * ## Tansactions
+ * # Tansactions
  * The transaction API allows you create and manage
  * payments on your integration
  */
-export declare class Transaction implements ITransaction {
+export declare class Transaction {
     private http;
     constructor(http: Axios);
     /**
@@ -25,5 +20,12 @@ export declare class Transaction implements ITransaction {
     initialize(data: InitializeTransaction): Promise<TransactionResponse | BadRequest>;
     verify(reference: string): Promise<TransactionResponse | BadRequest>;
     list(queryParams: ListTransactionQueryParams): Promise<TransactionResponse | BadRequest>;
+    fetch(id: string): Promise<TransactionResponse | BadRequest>;
+    chargeAuthorization(data: ChargeAuthorization): Promise<TransactionResponse | BadRequest>;
+    checkAuthorization(data: CheckAuthorization): Promise<TransactionResponse | BadRequest>;
+    viewTimeline(id: string): Promise<TransactionResponse | BadRequest>;
+    totals(queryParams: ListTransactionQueryParams): Promise<TransactionResponse | BadRequest>;
+    export(queryParams: ListTransactionQueryParams): Promise<TransactionResponse | BadRequest>;
+    partialDebit(data: PartialDebit): Promise<TransactionResponse | BadRequest>;
 }
 export {};

package/dist/transaction/transaction.js

@@ -1,5 +1,5 @@
 /**
- * ## Tansactions
+ * # Tansactions
  * The transaction API allows you create and manage
  * payments on your integration
  */
@@ -28,4 +28,36 @@ export class Transaction {
         });
         return JSON.parse(response.data);
     }
+    async fetch(id) {
+        const response = await this.http.get(`/transaction/:${id}`);
+        return JSON.parse(response.data);
+    }
+    async chargeAuthorization(data) {
+        const response = await this.http.post('/transaction/charge_authorization', JSON.stringify(data));
+        return JSON.parse(response.data);
+    }
+    async checkAuthorization(data) {
+        const response = await this.http.post('/transaction/check_authorization', JSON.stringify(data));
+        return JSON.parse(response.data);
+    }
+    async viewTimeline(id) {
+        const response = await this.http.get(`/transaction/timeline/${id}`);
+        return JSON.parse(response.data);
+    }
+    async totals(queryParams) {
+        const response = await this.http.get('/transaction/totals', {
+            params: { ...queryParams },
+        });
+        return JSON.parse(response.data);
+    }
+    async export(queryParams) {
+        const response = await this.http.get('/transaction/export', {
+            params: { ...queryParams },
+        });
+        return JSON.parse(response.data);
+    }
+    async partialDebit(data) {
+        const response = await this.http.post('/transaction/partial_debit', JSON.stringify(data));
+        return JSON.parse(response.data);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "1.0.9",
+  "version": "1.0.13",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Koderant",
@@ -40,6 +40,5 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/en1tan/paystack-node.git"
-  },
-  "type": "module"
+  }
 }