carbon-baas-sdk 1.0.3 → 1.0.5

package/README.md

@@ -22,8 +22,12 @@ const carbon = require('carbon-baas-sdk');
 
 carbon.initialize('your_api_key_here', 'sandbox');
 
-// Create an account
-carbon.createAccount('customer_id', 'static')
+// Create an account for a third-party customer
+carbon.createAccount({
+  account_type: 'static',
+  third_party: true,
+  customer_id: 'customer_123'
+})
   .then(response => console.log(response))
   .catch(error => console.error(error));
 
@@ -31,26 +35,44 @@ carbon.createAccount('customer_id', 'static')
 carbon.fetchAccount('account_number')
   .then(response => console.log(response))
   .catch(error => console.error(error));
+
+// Fetch all accounts with pagination
+carbon.fetchAccounts(1, 10) // page 1, limit 10
+  .then(response => console.log(response))
+  .catch(error => console.error(error));
+
+// Fetch account balance
+carbon.fetchAccountBalance('account_number')
+  .then(response => console.log(response))
+  .catch(error => console.error(error));
 ```
 
 ### ES Modules
 
 ```javascript
-import { initialize, createAccount, fetchAccount } from 'carbon-baas-sdk';
+import { initialize, createAccount, fetchAccount, fetchAccounts, fetchAccountBalance } from 'carbon-baas-sdk';
 
 initialize('your_api_key_here', 'sandbox');
 
-// Create an account
-const account = await createAccount('customer_id', 'static');
+// Create an account for a third-party customer
+const account = await createAccount({
+  account_type: 'static',
+  third_party: true,
+  customer_id: 'customer_123'
+});
 console.log(account);
 
 // Fetch an account
 const accountDetails = await fetchAccount('account_number');
 console.log(accountDetails);
 
-//Fetch accounts
-const accounts = await fetchAccounts(page?: number, limit?: number);
+// Fetch accounts
+const accounts = await fetchAccounts(1, 10); // page 1, limit 10
 console.log(accounts);
+
+// Fetch account balance
+const balance = await fetchAccountBalance('account_number');
+console.log(balance);
 ```
 
 ```javascript
@@ -69,9 +91,18 @@ initialize(apiKey: string, mode: 'live' | 'sandbox')
 ### Accounts
 ```javascript
 createAccount(accountData: CreateAccountRequest)
-// accountData: { customer_id: string, account_type: string }
+// accountData: { 
+//   account_type: "static",      // Must always be "static"
+//   third_party?: boolean,       // true for third-party customer, false for own business sub-account (defaults to true)
+//   customer_id?: string,        // Required if third_party is true
+//   account_name?: string        // Required if third_party is false
+// }
 
 fetchAccount(accountNumber: string)
+
+fetchAccounts(page?: number, limit?: number)
+
+fetchAccountBalance(accountNumber: string)
 ```
 
 ### Customers
@@ -122,6 +153,8 @@ initiatePayout(payoutData: InitiatePayoutRequest)
 // }
 
 fetchPayout(payoutId: string)
+
+fetchPayoutsWithPendingApprovals(includeExpired?: boolean)
 ```
 
 ### Banks
@@ -136,10 +169,6 @@ fetchBanksUptime()
 
 ### Webhooks
 ```javascript
-fetchWebhook()
-
-updateWebhook(data: UpdateWebhookRequest)
-// data: { url: string }
 
 fetchWebhookHistory(page?: number, limit?: number)
 
@@ -150,16 +179,30 @@ resendWebhookEvent(eventId: string)
 
 ### Managing Accounts
 ```javascript
-import { createAccount, fetchAccount } from 'carbon-baas-sdk';
+import { createAccount, fetchAccount, fetchAccounts, fetchAccountBalance } from 'carbon-baas-sdk';
 
-// Create an account
-const newAccount = await createAccount({
-  customer_id: 'customer_123',
-  account_type: 'static'
+// Create an account for a third-party customer
+const newCustomerAccount = await createAccount({
+  account_type: 'static',
+  third_party: true,
+  customer_id: 'customer_123'
+});
+
+// Create a sub-account for your own business (for collections)
+const newSubAccount = await createAccount({
+  account_type: 'static',
+  third_party: false,
+  account_name: 'Collections'
 });
 
 // Fetch account details
 const accountDetails = await fetchAccount('1234567890');
+
+// Fetch account balance
+const balance = await fetchAccountBalance('1234567890');
+
+// Fetch all accounts (with pagination)
+const accounts = await fetchAccounts(1, 20); // page 1, 20 items per page
 ```
 
 ### Managing Customers
@@ -188,6 +231,37 @@ const newCustomer = await createCustomer(customerData);
 const customerDetails = await fetchCustomer('customer_id');
 ```
 
+### Managing Payouts
+```javascript
+import { initiatePayout, fetchPayout, fetchPayoutsWithPendingApprovals } from 'carbon-baas-sdk';
+
+// Initiate a payout
+const payoutData = {
+  amount: 1000,
+  source: { account_number: '1234567890' },
+  beneficiary: {
+    bank_code: '058',
+    bank_name: 'GTB',
+    account_number: '0987654321',
+    account_name: 'John Doe'
+  },
+  reference: 'payout_ref_123',
+  meta_data: { description: 'Payment for services' },
+  remark: 'Service payment'
+};
+
+const payout = await initiatePayout(payoutData);
+
+// Fetch payout details
+const payoutDetails = await fetchPayout('payout_id');
+
+// Fetch payouts with pending approvals
+const pendingPayouts = await fetchPayoutsWithPendingApprovals();
+
+// Fetch payouts with pending approvals including expired ones
+const allPendingPayouts = await fetchPayoutsWithPendingApprovals(true);
+```
+
 ### Managing Webhooks
 ```javascript
 import { resendWebhookEvent, fetchWebhookHistory } from 'carbon-baas-sdk';

package/dist/accounts.d.ts

@@ -1,8 +1,19 @@
 interface CreateAccountRequest {
-    customer_id: string;
-    account_type: string;
+    /** Must always be "static". */
+    account_type: "static";
+    /**
+     * Set to true when creating an account for a third-party customer (business use).
+     * Set to false when creating a sub-account for your own business (collections).
+     * Defaults to true if not provided.
+     */
+    third_party?: boolean;
+    /** Required if third_party is true. The customer to associate the account with. */
+    customer_id?: string;
+    /** Required if third_party is false. The sub-account name (e.g."SUBACCOUNT" -> BUSINESS NAME - SUBACCOUNT). */
+    account_name?: string;
 }
 export declare function createAccount(accountData: CreateAccountRequest): Promise<any>;
 export declare function fetchAccount(accountNumber: string): Promise<any>;
 export declare function fetchAccounts(page?: number, limit?: number): Promise<any>;
+export declare function fetchAccountBalance(accountNumber: string): Promise<any>;
 export {};

package/dist/config.d.ts

@@ -0,0 +1,5 @@
+export interface EnvironmentConfig {
+    baseUrl: string;
+    accessKey: string;
+}
+export declare const CONFIG: Record<'live' | 'sandbox', EnvironmentConfig>;

package/dist/customers.d.ts

@@ -10,7 +10,7 @@ interface CreateCustomerRequest {
     state: string;
     country: string;
     bvn: string;
-    nin: string;
+    nin?: string;
 }
 export declare function createCustomer(customerData: CreateCustomerRequest): Promise<any>;
 export declare function fetchCustomer(customerId: string): Promise<any>;