carbon-baas-sdk 1.0.0

package/README.md

@@ -0,0 +1,236 @@
+# Carbon Business API SDK
+
+This SDK provides a simple interface to interact with the Carbon Business API, allowing developers to integrate Carbon's financial services into their applications.
+
+## API Documentation
+[![Postman](https://img.shields.io/badge/Postman-E97627?style=for-the-badge&logo=Postman&logoColor=white)](https://documenter.getpostman.com/view/33237778/2sA2rFRzKS#37cff604-7f17-448f-afe4-2a456f8ad23a)
+
+## Installation
+
+```bash
+npm install carbon-baas-sdk
+```
+
+## Configuration
+
+Initialize the SDK with your API key and mode (live or sandbox):
+
+### CommonJS
+
+```javascript
+const carbon = require('carbon-baas-sdk');
+
+carbon.initialize('your_api_key_here', 'sandbox');
+
+// Create an account
+carbon.createAccount('customer_id', 'static')
+  .then(response => console.log(response))
+  .catch(error => console.error(error));
+
+// Fetch an account
+carbon.fetchAccount('account_number')
+  .then(response => console.log(response))
+  .catch(error => console.error(error));
+```
+
+### ES Modules
+
+```javascript
+import { initialize, createAccount, fetchAccount } from 'carbon-baas-sdk';
+
+initialize('your_api_key_here', 'sandbox');
+
+// Create an account
+const account = await createAccount('customer_id', 'static');
+console.log(account);
+
+// Fetch an account
+const accountDetails = await fetchAccount('account_number');
+console.log(accountDetails);
+```
+
+```javascript
+import { initialize } from 'carbon-baas-sdk';
+
+initialize('your_api_key_here', 'sandbox');
+```
+
+## API Reference
+
+### Authentication
+```javascript
+initialize(apiKey: string, mode: 'live' | 'sandbox')
+```
+
+### Accounts
+```javascript
+createAccount(accountData: CreateAccountRequest)
+// accountData: { customer_id: string, account_type: string }
+
+fetchAccount(accountNumber: string)
+```
+
+### Customers
+```javascript
+createCustomer(customerData: CreateCustomerRequest)
+// customerData: {
+//   first_name: string;
+//   last_name: string;
+//   email: string;
+//   phone: string;
+//   dob: string;
+//   gender: string;
+//   street: string;
+//   city: string;
+//   state: string;
+//   country: string;
+//   bvn: string;
+//   nin: string;
+// }
+
+fetchCustomer(customerId: string)
+
+fetchCustomers(page?: number, limit?: number)
+```
+
+### Transactions
+```javascript
+verifyTransaction(accountNumber: string, reference: string)
+
+fetchTransactions(accountNumber: string, page?: number, limit?: number)
+```
+
+### Payouts
+```javascript
+initiatePayout(payoutData: InitiatePayoutRequest)
+// payoutData: {
+//   amount: number;
+//   source: { account_number: string };
+//   beneficiary: {
+//     bank_code: string;
+//     bank_name: string;
+//     account_number: string;
+//     account_name: string;
+//   };
+//   reference: string;
+//   meta_data: object;
+//   remark: string;
+// }
+
+fetchPayout(payoutId: string)
+```
+
+### Banks
+```javascript
+fetchBanks()
+
+resolveAccount(accountData: ResolveAccountRequest)
+// accountData: { account_number: string, bank_code: string }
+
+fetchBanksUptime()
+```
+
+### Webhooks
+```javascript
+fetchWebhook()
+
+updateWebhook(data: UpdateWebhookRequest)
+// data: { url: string }
+
+fetchWebhookHistory(page?: number, limit?: number)
+
+resendWebhookEvent(eventId: string)
+```
+
+## Example Usage
+
+### Managing Accounts
+```javascript
+import { createAccount, fetchAccount } from 'carbon-baas-sdk';
+
+// Create an account
+const newAccount = await createAccount({
+  customer_id: 'customer_123',
+  account_type: 'static'
+});
+
+// Fetch account details
+const accountDetails = await fetchAccount('1234567890');
+```
+
+### Managing Customers
+```javascript
+import { createCustomer, fetchCustomer } from 'carbon-baas-sdk';
+
+// Create a customer
+const customerData = {
+  first_name: 'John',
+  last_name: 'Doe',
+  email: 'john.doe@example.com',
+  phone: '2348012345678',
+  dob: '1990-01-01',
+  gender: 'male',
+  street: '123 Main St',
+  city: 'Lagos',
+  state: 'Lagos',
+  country: 'Nigeria',
+  bvn: '12345678901',
+  nin: '12345678901'
+};
+
+const newCustomer = await createCustomer(customerData);
+
+// Fetch customer details
+const customerDetails = await fetchCustomer('customer_id');
+```
+
+### Managing Webhooks
+```javascript
+import { updateWebhook, fetchWebhookHistory } from 'carbon-baas-sdk';
+
+// Update webhook URL
+const webhook = await updateWebhook({
+  url: 'https://your-webhook-endpoint.com/webhook'
+});
+
+// Fetch webhook history
+const history = await fetchWebhookHistory(1, 10);
+```
+
+### Bank Operations
+```javascript
+import { fetchBanks, resolveAccount, fetchBanksUptime } from 'carbon-baas-sdk';
+
+// Fetch all banks
+const banks = await fetchBanks();
+
+// Resolve account
+const accountDetails = await resolveAccount({
+  account_number: '1234567890',
+  bank_code: '058'
+});
+
+// Check banks uptime
+const uptime = await fetchBanksUptime();
+```
+
+## Error Handling
+
+The SDK uses a consistent error handling pattern. All API calls return a response object that includes status and error information when applicable:
+
+```javascript
+try {
+  const result = await createCustomer(customerData);
+  if (result.status === 'failed') {
+    console.error('API Error:', result.message, result.errors);
+  } else {
+    console.log('Success:', result.data);
+  }
+} catch (error) {
+  console.error('Request failed:', error);
+}
+```
+
+## License
+
+This project is licensed under the MIT License.

package/dist/accounts.d.ts

@@ -0,0 +1,7 @@
+interface CreateAccountRequest {
+    customer_id: string;
+    account_type: string;
+}
+export declare function createAccount(accountData: CreateAccountRequest): Promise<any>;
+export declare function fetchAccount(accountNumber: string): Promise<any>;
+export {};

package/dist/banks.d.ts

@@ -0,0 +1,8 @@
+interface ResolveAccountRequest {
+    account_number: string;
+    bank_code: string;
+}
+export declare function fetchBanks(): Promise<any>;
+export declare function resolveAccount(accountData: ResolveAccountRequest): Promise<any>;
+export declare function fetchBanksUptime(): Promise<any>;
+export {};

package/dist/customers.d.ts

@@ -0,0 +1,18 @@
+interface CreateCustomerRequest {
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone: string;
+    dob: string;
+    gender: string;
+    street: string;
+    city: string;
+    state: string;
+    country: string;
+    bvn: string;
+    nin: string;
+}
+export declare function createCustomer(customerData: CreateCustomerRequest): Promise<any>;
+export declare function fetchCustomer(customerId: string): Promise<any>;
+export declare function fetchCustomers(page?: number, limit?: number): Promise<any>;
+export {};