carbon-baas-sdk 1.0.4 → 1.0.5

package/README.md

@@ -40,12 +40,17 @@ carbon.fetchAccount('account_number')
 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, fetchAccounts } from 'carbon-baas-sdk';
+import { initialize, createAccount, fetchAccount, fetchAccounts, fetchAccountBalance } from 'carbon-baas-sdk';
 
 initialize('your_api_key_here', 'sandbox');
 
@@ -64,6 +69,10 @@ console.log(accountDetails);
 // 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
@@ -92,6 +101,8 @@ createAccount(accountData: CreateAccountRequest)
 fetchAccount(accountNumber: string)
 
 fetchAccounts(page?: number, limit?: number)
+
+fetchAccountBalance(accountNumber: string)
 ```
 
 ### Customers
@@ -142,6 +153,8 @@ initiatePayout(payoutData: InitiatePayoutRequest)
 // }
 
 fetchPayout(payoutId: string)
+
+fetchPayoutsWithPendingApprovals(includeExpired?: boolean)
 ```
 
 ### Banks
@@ -156,10 +169,6 @@ fetchBanksUptime()
 
 ### Webhooks
 ```javascript
-fetchWebhook()
-
-updateWebhook(data: UpdateWebhookRequest)
-// data: { url: string }
 
 fetchWebhookHistory(page?: number, limit?: number)
 
@@ -170,7 +179,7 @@ resendWebhookEvent(eventId: string)
 
 ### Managing Accounts
 ```javascript
-import { createAccount, fetchAccount, fetchAccounts } from 'carbon-baas-sdk';
+import { createAccount, fetchAccount, fetchAccounts, fetchAccountBalance } from 'carbon-baas-sdk';
 
 // Create an account for a third-party customer
 const newCustomerAccount = await createAccount({
@@ -189,6 +198,9 @@ const newSubAccount = await createAccount({
 // 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
 ```
@@ -219,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

@@ -15,4 +15,5 @@ interface CreateAccountRequest {
 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>;