paystack-sdk 3.6.0 → 3.7.0

package/README.md

@@ -2,10 +2,28 @@
 
 #### Why Another [Paystack](https://paystack.com) Package?
 
-Existing Paystack libraries are either outdated, lack modern features, or fail to support TypeScript. This package addresses these gaps by providing:  
--  Full TypeScript support for type safety and better developer experience.
--  A modern, actively maintained library aligned with Paystack’s latest API updates.
--  Clean, intuitive APIs designed for ease of use.  
+Existing Paystack libraries are either outdated, lack modern features, or fail to support TypeScript. This package addresses these gaps by providing:
+
+- Full TypeScript support for type safety and better developer experience.
+- A modern, actively maintained library aligned with Paystack’s latest API updates.
+- Clean, intuitive APIs designed for ease of use.
+
+## Deprecation Notice
+
+Named import will be removed in version 4.0.0. Migrate to default import.
+Change
+
+```ts
+import { Paystack } from 'paystack-sdk';
+const Paystack = require('paystack-sdk').Paystack;
+```
+
+To
+
+```ts
+import Paystack from 'paystack-sdk';
+const Paystack = require('paystack-sdk');
+```
 
 ### Installation
 
@@ -19,31 +37,20 @@ For NPM
 
 For Typescript
 
-```typescript
-import {Paystack} from 'paystack-sdk';
-// or
+```ts
 import Paystack from 'paystack-sdk';
 
-const paystack = new Paystack("secret_key");
+const paystack = new Paystack('secret_key');
 ```
 
 For Javscript
 
-```javascript
-const Paystack = require('paystack-sdk').Paystack;
-// or
+```js
 const Paystack = require('paystack-sdk');
 
 const paystack = new Paystack('secret_key');
 ```
 
-OR
-
-```javascript
-const { Paystack } = require('paystack-sdk');
-const paystack = new Paystack('secret_key');
-```
-
 All methods use promise meaning you can either use the `async...await` or `then...catch` or `try...catch`
 
 ### Modules

package/dist/dedicated/dedicated.d.ts

@@ -1,5 +1,5 @@
 import { Axios } from 'axios';
-import { CreateDedicatedVirtualAccount, DeactivateDedicatedAccountResponse, DedicatedAccountCreatedResponse, FetchBankProvidersResponse, FetchDedicatedVirtualAccountResponse, ListDedicatedVirtualAccountsQueryParams, ListDedicatedVirtualAccountsResponse, RemoveSplitDedicatedAccountResponse, SplitDedicatedAccountTransaction, SplitDedicatedAccountTransactionResponse } from './interface';
+import { AssignDedicatedVirtualAccount, CreateDedicatedVirtualAccount, DeactivateDedicatedAccountResponse, DedicatedAccountAssignedResponse, DedicatedAccountCreatedResponse, FetchBankProvidersResponse, FetchDedicatedVirtualAccountResponse, ListDedicatedVirtualAccountsQueryParams, ListDedicatedVirtualAccountsResponse, RemoveSplitDedicatedAccountResponse, SplitDedicatedAccountTransaction, SplitDedicatedAccountTransactionResponse } from './interface';
 interface BadRequest {
     status: boolean;
     message: string;
@@ -8,6 +8,7 @@ export declare class DedicatedAccount {
     http: Axios;
     constructor(http: Axios);
     create(data: CreateDedicatedVirtualAccount): Promise<DedicatedAccountCreatedResponse | BadRequest>;
+    assign(data: AssignDedicatedVirtualAccount): Promise<DedicatedAccountAssignedResponse | BadRequest>;
     list(queryParams: ListDedicatedVirtualAccountsQueryParams): Promise<ListDedicatedVirtualAccountsResponse | BadRequest>;
     fetch(dedicatedAccountId: string): Promise<FetchDedicatedVirtualAccountResponse | BadRequest>;
     deactivate(dedicatedAccountId: string): Promise<DeactivateDedicatedAccountResponse | BadRequest>;

package/dist/dedicated/dedicated.js

@@ -8,6 +8,9 @@ class DedicatedAccount {
     async create(data) {
         return await this.http.post('/dedicated_account', JSON.stringify(data));
     }
+    async assign(data) {
+        return await this.http.post('/dedicated_account/assign', JSON.stringify(data));
+    }
     async list(queryParams) {
         return await this.http.get('/dedicated_account', {
             params: { ...queryParams },

package/dist/dedicated/interface.d.ts

@@ -29,6 +29,22 @@ export interface CreateDedicatedVirtualAccount {
     last_name?: string;
     phone?: string;
 }
+export interface AssignDedicatedVirtualAccount {
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone: string;
+    preferred_bank: string;
+    country: 'NG' | 'GH';
+    account_number?: string;
+    bvn?: string;
+    bank_code?: string;
+    subaccount?: string;
+    split_code?: string;
+}
+export interface DedicatedAccountAssignedResponse extends Response {
+    data: AssignDedicatedVirtualAccount;
+}
 export interface ListDedicatedVirtualAccountsQueryParams {
     active: boolean;
     currency: string;

package/dist/misc/interface.d.ts

@@ -27,7 +27,7 @@ export type Country = {
     name: string;
     iso_code: string;
     default_currency_code: string;
-    integration_defaults: Record<string, any>;
+    integration_defaults: Record<string, unknown>;
     relationships: Relationship;
 };
 export type State = {

package/dist/paystack.d.ts

@@ -21,12 +21,6 @@ import { Misc } from './misc/misc';
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
  */
-/**
- * @deprecated This named export is deprecated and will be removed
- * in version `4.0.0`.
- * Use the default export instead:
- * Use `import Paystack from 'paystack-sdk'`
- */
 export declare class Paystack {
     private readonly key;
     private readonly http;

package/dist/paystack.js

@@ -28,12 +28,6 @@ const axios_1 = __importDefault(require("axios"));
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
  */
-/**
- * @deprecated This named export is deprecated and will be removed
- * in version `4.0.0`.
- * Use the default export instead:
- * Use `import Paystack from 'paystack-sdk'`
- */
 class Paystack {
     constructor(key) {
         this.key = key;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Tech Priest",