timber-node 0.4.4 → 0.4.6

package/README.md

@@ -1,123 +1,127 @@
-# Timber SDK
-
-Official Node.js SDK for integrating with the Timber accounting backend API.
-
-Easily interact with Timber's core features like managing expenses, invoices, vendors, customers, payroll, and more using a unified SDK.
-
-## Installation
-
-```bash
-npm install timber-node
-```
-
-## Getting Started
-
-```typescript
-import { createClient } from 'timber-node';
-
-const client = createClient('your-api-key', {
-  baseURL: 'https://api.timber.me', // optional
-});
-
-// Example: List expenses
-const expenses = await client.expense.list({ page: 1, limit: 10 });
-console.log(expenses.data);
-```
-
-## Authentication
-
-Timber uses API Key-based authentication. Generate this API key from your Timber profile developer settings.
-
-```typescript
-const client = createClient('your-api-key');
-```
-
-You can also load your API key from environment variables using `dotenv`.
-
-## SDK Structure
-
-The SDK client exposes the following services:
-
-```typescript
-client.expense;
-client.expenseCategory;
-client.rawExpense;
-client.invoice;
-client.invoicePayment;
-client.vendorPayment;
-client.billPayment;
-client.customer;
-client.taxRate;
-client.salary;
-client.employee;
-client.bankStatement;
-client.cheque;
-```
-
-Each service provides common operations like `create`, `get`, `list`, `update`, and `delete` where applicable.
-
-## Usage Examples
-
-### Create an Expense
-
-```typescript
-const response = await client.expense.create({
-  type: 'Travel',
-  merchant: 'Uber',
-  category: 'Transportation',
-  date: '2025-06-23',
-  payment_method: 'cash',
-  amount: 45.75,
-});
-console.log(response.data);
-```
-
-### List Expenses
-
-```typescript
-const response = await client.expense.list({ page: 1, limit: 5 });
-console.log(response.data);
-```
-
-### Update an Expense
-
-```typescript
-const updates = { amount: 50.0 };
-const response = await client.expense.update('expense_id_here', updates);
-console.log(response.data);
-```
-
-### Delete an Expense
-
-```typescript
-const response = await client.expense.delete('expense_id_here');
-console.log(response.data.message);
-```
-
-## TypeScript Support
-
-The SDK includes full TypeScript support:
-
-```typescript
-import type { Expense, CreateExpenseRequest } from 'timber-node';
-```
-
-## Error Handling
-
-Errors are returned as Axios errors:
-
-```typescript
-import axios from 'axios';
-
-try {
-  await client.expense.get('invalid-id');
-} catch (err) {
-  if (axios.isAxiosError(err)) {
-    console.error(err.response?.status, err.response?.data);
-  }
-}
-```
-
-## Related Links
-
-- [Timber Website](https://timber.me)
+# Timber SDK
+
+Official Node.js SDK for integrating with the Timber accounting backend API.
+
+Easily interact with Timber's core features like managing expenses, invoices, vendors, customers, payroll, and more using a unified SDK.
+
+## Installation
+
+```bash
+npm install timber-node
+```
+
+## Getting Started
+
+```typescript
+import { createClient } from 'timber-node';
+
+const client = createClient('your-api-key', {
+  baseURL: 'https://api.timber.me', // optional
+});
+
+// Example: List expenses
+const expenses = await client.expense.list({ page: 1, limit: 10 });
+console.log(expenses.data);
+```
+
+## Authentication
+
+Timber uses API Key-based authentication. Generate this API key from your Timber profile developer settings.
+
+```typescript
+const client = createClient('your-api-key');
+```
+
+You can also load your API key from environment variables using `dotenv`.
+
+## SDK Structure
+
+The SDK client exposes the following services:
+
+```typescript
+client.expense;
+client.expenseCategory;
+client.rawExpense;
+client.invoice;
+client.invoicePayment;
+client.vendorPayment;
+client.billPayment;
+client.customer;
+client.taxRate;
+client.salary;
+client.employee;
+client.cheque;
+client.bankStatement;
+client.company;
+client.invoiceNumber;
+client.invoiceSettings;
+client.invoiceItem;
+```
+
+Each service provides common operations like `create`, `get`, `list`, `update`, and `delete` where applicable.
+
+## Usage Examples
+
+### Create an Expense
+
+```typescript
+const response = await client.expense.create({
+  type: 'Travel',
+  merchant: 'Uber',
+  category: 'Transportation',
+  date: '2025-06-23',
+  payment_method: 'cash',
+  amount: 45.75,
+});
+console.log(response.data);
+```
+
+### List Expenses
+
+```typescript
+const response = await client.expense.list({ page: 1, limit: 5 });
+console.log(response.data);
+```
+
+### Update an Expense
+
+```typescript
+const updates = { amount: 50.0 };
+const response = await client.expense.update('expense_id_here', updates);
+console.log(response.data);
+```
+
+### Delete an Expense
+
+```typescript
+const response = await client.expense.delete('expense_id_here');
+console.log(response.data.message);
+```
+
+## TypeScript Support
+
+The SDK includes full TypeScript support:
+
+```typescript
+import type { Expense, CreateExpenseRequest } from 'timber-node';
+```
+
+## Error Handling
+
+Errors are returned as Axios errors:
+
+```typescript
+import axios from 'axios';
+
+try {
+  await client.expense.get('invalid-id');
+} catch (err) {
+  if (axios.isAxiosError(err)) {
+    console.error(err.response?.status, err.response?.data);
+  }
+}
+```
+
+## Related Links
+
+- [Timber Website](https://timber.me)

package/dist/auth.js

@@ -63,7 +63,7 @@ class AuthService {
      * ```
      */
     async create(data) {
-        return await this.http.post('/auth/register', data);
+        return await this.http.post('/user/sdk/auth/register', data);
     }
 }
 exports.AuthService = AuthService;

package/dist/bankStatement.js

@@ -30,7 +30,9 @@ class BankStatementService {
      * ```
      */
     async list(params = {}) {
-        return await this.http.get('/customer/reconcile/bank-statement', { params });
+        return await this.http.get('/reconcile/sdk/customer/bank-statement', {
+            params,
+        });
     }
     /**
      * Create a new bank statement.
@@ -55,7 +57,7 @@ class BankStatementService {
         else {
             throw new Error('File is required');
         }
-        return await this.http.post('/customer/reconcile/bank-statement', formData, {
+        return await this.http.post('/reconcile/sdk/customer/bank-statement', formData, {
             headers,
             cancelToken: data.cancelToken,
             onUploadProgress: data.progressCallback,

package/dist/billPayment.js

@@ -30,7 +30,7 @@ class BillPaymentService {
      * ```
      */
     async list(params) {
-        return await this.http.get('/customer/purchase/payment-record', {
+        return await this.http.get('/user/sdk/customer/purchase/payment-record', {
             params,
         });
     }
@@ -79,7 +79,7 @@ class BillPaymentService {
         if (data.file) {
             formData.append('file', data.file);
         }
-        return await this.http.post('/customer/purchase/payment-record', formData, {
+        return await this.http.post('/user/sdk/customer/purchase/payment-record', formData, {
             headers,
         });
     }
@@ -118,7 +118,7 @@ class BillPaymentService {
         if (data.file) {
             formData.append('file', data.file);
         }
-        return await this.http.put(`/customer/purchase/payment-record/${id}`, formData, {
+        return await this.http.put(`/user/sdk/customer/purchase/payment-record/${id}`, formData, {
             headers,
         });
     }
@@ -135,7 +135,7 @@ class BillPaymentService {
      * ```
      */
     async delete(id) {
-        return await this.http.delete(`/customer/purchase/payment-record/${id}`);
+        return await this.http.delete(`/user/sdk/customer/purchase/payment-record/${id}`);
     }
 }
 exports.BillPaymentService = BillPaymentService;

package/dist/cheque.js

@@ -30,7 +30,7 @@ class ChequeService {
      * ```
      */
     async list(params = {}) {
-        return await this.http.get('/customer/reconcile/cheque', { params });
+        return await this.http.get('/reconcile/sdk/customer/cheque', { params });
     }
     /**
      * Create a new cheque.
@@ -55,7 +55,7 @@ class ChequeService {
         else {
             throw new Error('File is required');
         }
-        return await this.http.post('/customer/reconcile/cheque', formData, {
+        return await this.http.post('/reconcile/sdk/customer/cheque', formData, {
             headers,
             cancelToken: data.cancelToken,
             onUploadProgress: data.progressCallback,

package/dist/company.d.ts

@@ -4,13 +4,26 @@ export interface CompanyData {
     currency: string;
     language: string;
     address: string;
+    address_details: Map<string, any>;
     city: string;
     state: string;
     zip_code: string;
-    country: string;
+    country: {
+        _id: string;
+        name: string;
+        country_code: string;
+        currency: string;
+        timezone: string;
+        logo: string;
+        is_active: boolean;
+        created_at: string;
+        updated_at: string;
+    };
     email: string;
     country_code: string;
     mobile: string;
+    is_zakat: boolean;
+    zakat_number: string;
     tax_number: string;
     financial_start_date: string;
     license_expiry: string;
@@ -25,6 +38,7 @@ export interface CompanyData {
     license_number: string;
     license_authority: string;
     trn: string;
+    crn: string;
 }
 export interface Company extends CompanyData {
     _id: string;

package/dist/company.js

@@ -48,7 +48,7 @@ class CompanyService {
      * ```
      */
     async get() {
-        return await this.http.get(`/customer/company`);
+        return await this.http.get(`/user/sdk/customer/company`);
     }
     /**
      * Create a new company.
@@ -118,7 +118,7 @@ class CompanyService {
         data.sector.forEach((item, index) => {
             formData.append(`sector[${index}]`, item);
         });
-        return await this.http.post('/customer/company', formData, {
+        return await this.http.post('/user/sdk/customer/company', formData, {
             headers: formData.getHeaders(),
         });
     }
@@ -169,7 +169,7 @@ class CompanyService {
                 formData.append(`sector[${index}]`, item);
             });
         }
-        return await this.http.put(`/customer/company/${id}`, data, {
+        return await this.http.put(`/user/sdk/customer/company/${id}`, data, {
             headers: formData.getHeaders(),
         });
     }
@@ -185,7 +185,7 @@ class CompanyService {
      * ```
      *   */
     async default(id) {
-        return await this.http.patch(`/customer/company/${id}/default`);
+        return await this.http.patch(`/user/sdk/customer/company/${id}/default`);
     }
 }
 exports.CompanyService = CompanyService;

package/dist/customer.d.ts

@@ -8,6 +8,7 @@ export interface CustomerData {
     city: string;
     role: 'customer' | 'vendor' | 'biller';
     address: string;
+    address_details?: Record<string, string>;
     trn?: string;
     [key: string]: any;
 }

package/dist/customer.js

@@ -30,7 +30,7 @@ class CustomerService {
      * ```
      */
     async list(params = { role: 'customer' }) {
-        return await this.http.get('/customer/customer', { params });
+        return await this.http.get('/user/sdk/customer/customer', { params });
     }
     /**
      * Fetch a single customer by ID.
@@ -46,17 +46,36 @@ class CustomerService {
      */
     async create(data) {
         const { formData, headers } = await (0, getFormData_1.getFormData)();
-        Object.entries(data).forEach(([key, value]) => {
+        const appendFormData = (key, value) => {
+            if (value === undefined || value === null)
+                return;
             if (value instanceof File) {
                 formData.append(key, value);
+                return;
             }
-            else {
-                formData.append(key, value);
+            if (Array.isArray(value)) {
+                value.forEach((item, index) => {
+                    if (item instanceof File) {
+                        formData.append(key, item);
+                    }
+                    else {
+                        appendFormData(`${key}[${index}]`, item);
+                    }
+                });
+                return;
             }
+            if (typeof value === 'object') {
+                Object.entries(value).forEach(([childKey, childValue]) => {
+                    appendFormData(`${key}[${childKey}]`, childValue);
+                });
+                return;
+            }
+            formData.append(key, String(value));
+        };
+        Object.entries(data).forEach(([key, value]) => {
+            appendFormData(key, value);
         });
-        return await this.http.post('/customer/customer', formData, {
-            headers,
-        });
+        return await this.http.post('/user/sdk/customer/customer', formData, { headers });
     }
     /**
      * Update an existing customer.
@@ -74,15 +93,36 @@ class CustomerService {
      */
     async update(id, data) {
         const { formData, headers } = await (0, getFormData_1.getFormData)();
-        Object.entries(data).forEach(([key, value]) => {
+        const appendFormData = (key, value) => {
+            if (value === undefined || value === null)
+                return;
             if (value instanceof File) {
                 formData.append(key, value);
+                return;
             }
-            else {
-                formData.append(key, value);
+            if (Array.isArray(value)) {
+                value.forEach((item, index) => {
+                    if (item instanceof File) {
+                        formData.append(key, item);
+                    }
+                    else {
+                        appendFormData(`${key}[${index}]`, item);
+                    }
+                });
+                return;
             }
+            if (typeof value === 'object') {
+                Object.entries(value).forEach(([childKey, childValue]) => {
+                    appendFormData(`${key}[${childKey}]`, childValue);
+                });
+                return;
+            }
+            formData.append(key, String(value));
+        };
+        Object.entries(data).forEach(([key, value]) => {
+            appendFormData(key, value);
         });
-        return await this.http.put(`/customer/customer/${id}`, formData, {
+        return await this.http.put(`/user/sdk/customer/customer/${id}`, formData, {
             headers,
         });
     }
@@ -99,7 +139,7 @@ class CustomerService {
      * ```
      */
     async delete(id) {
-        return await this.http.delete(`/customer/customer/${id}`);
+        return await this.http.delete(`/user/sdk/customer/customer/${id}`);
     }
 }
 exports.CustomerService = CustomerService;

package/dist/employee.js

@@ -18,7 +18,7 @@ class EmployeeService {
      * ```
      */
     async list(params) {
-        return await this.http.get('/customer/employee', {
+        return await this.http.get('/user/sdk/customer/employee', {
             params,
         });
     }

package/dist/expense.js

@@ -29,7 +29,7 @@ class ExpenseService {
      * ```
      */
     async list(params) {
-        return await this.http.get('/customer/expense', { params });
+        return await this.http.get('/user/sdk/customer/expense', { params });
     }
     /**
      * Fetch a single expense by ID.
@@ -44,7 +44,7 @@ class ExpenseService {
      * ```
      */
     async get(id) {
-        return await this.http.get(`/customer/expense/${id}`);
+        return await this.http.get(`/user/sdk/customer/expense/${id}`);
     }
     /**
      * Create a new expense.
@@ -67,7 +67,7 @@ class ExpenseService {
      * ```
      */
     async create(data) {
-        return await this.http.post('/customer/expense', data);
+        return await this.http.post('/user/sdk/customer/expense', data);
     }
     /**
      * Update an existing expense.
@@ -84,7 +84,7 @@ class ExpenseService {
      * ```
      */
     async update(id, data) {
-        return await this.http.put(`/customer/expense/${id}`, data);
+        return await this.http.put(`/user/sdk/customer/expense/${id}`, data);
     }
     /**
      * Delete an expense by ID.
@@ -99,7 +99,7 @@ class ExpenseService {
      * ```
      */
     async delete(id) {
-        return await this.http.patch(`/customer/expense/${id}`);
+        return await this.http.patch(`/user/sdk/customer/expense/${id}`);
     }
 }
 exports.ExpenseService = ExpenseService;

package/dist/expenseCategory.js

@@ -29,7 +29,7 @@ class ExpenseCategoryService {
      * ```
      */
     async list(params) {
-        return await this.http.get('/customer/expense/category', {
+        return await this.http.get('/user/sdk/customer/expense/category', {
             params,
         });
     }
@@ -49,7 +49,7 @@ class ExpenseCategoryService {
      * ```
      */
     async create(data) {
-        return await this.http.post('/customer/expense/category', data);
+        return await this.http.post('/user/sdk/customer/expense/category', data);
     }
     /**
      * Update an existing expense category.
@@ -66,7 +66,7 @@ class ExpenseCategoryService {
      * ```
      */
     async update(id, data) {
-        return await this.http.put(`/customer/expense/category/${id}`, data);
+        return await this.http.put(`/user/sdk/customer/expense/category/${id}`, data);
     }
     /**
      * Delete an expense category by ID.
@@ -81,7 +81,7 @@ class ExpenseCategoryService {
      * ```
      */
     async delete(id) {
-        return await this.http.delete(`/customer/expense/category/${id}`);
+        return await this.http.delete(`/user/sdk/customer/expense/category/${id}`);
     }
 }
 exports.ExpenseCategoryService = ExpenseCategoryService;

package/dist/index.d.ts

@@ -14,7 +14,7 @@ import { ChequeService } from './cheque';
 import { BankStatementService } from './bankStatement';
 import { CompanyService } from './company';
 import { InvoiceNumberService } from './invoiceNumber';
-import { InvoiceTemplateService } from './invoiceTemplates';
+import { InvoiceSettingsService } from './invoiceSettings';
 import { InvoiceItemService } from './invoiceItem';
 declare class TimberClient {
     auth: AuthService;
@@ -33,7 +33,7 @@ declare class TimberClient {
     bankStatement: BankStatementService;
     company: CompanyService;
     invoiceNumber: InvoiceNumberService;
-    invoiceTemplate: InvoiceTemplateService;
+    invoiceSettings: InvoiceSettingsService;
     invoiceItem: InvoiceItemService;
     constructor(apiKey: string, options?: {
         baseURL?: string;

package/dist/index.js

@@ -21,11 +21,11 @@ const cheque_1 = require("./cheque");
 const bankStatement_1 = require("./bankStatement");
 const company_1 = require("./company");
 const invoiceNumber_1 = require("./invoiceNumber");
-const invoiceTemplates_1 = require("./invoiceTemplates");
+const invoiceSettings_1 = require("./invoiceSettings");
 const invoiceItem_1 = require("./invoiceItem");
 class TimberClient {
     constructor(apiKey, options = {}) {
-        const baseURL = `${options.baseURL || 'https://api.timber.me'}/api/v1/user/sdk`;
+        const baseURL = `${options.baseURL || 'https://api.timber.me'}/api/v1`;
         // Create HTTP client for regular services (non-auth)
         const http = axios_1.default.create({
             baseURL: baseURL,
@@ -60,7 +60,7 @@ class TimberClient {
         this.bankStatement = new bankStatement_1.BankStatementService(http);
         this.company = new company_1.CompanyService(http);
         this.invoiceNumber = new invoiceNumber_1.InvoiceNumberService(http);
-        this.invoiceTemplate = new invoiceTemplates_1.InvoiceTemplateService(http);
+        this.invoiceSettings = new invoiceSettings_1.InvoiceSettingsService(http);
         this.invoiceItem = new invoiceItem_1.InvoiceItemService(http);
     }
 }