btechworks-sdk 1.0.3 → 1.0.6

package/README.md

@@ -54,6 +54,15 @@ await client.sendVideo({ phone: '+1234567890', videoUrl: 'https://example.com/vi
 
 // Send document
 await client.sendDocument({ phone: '+1234567890', documentUrl: 'https://example.com/file.pdf', filename: 'file.pdf' });
+
+// Send CTA URL button (Click-to-Chat)
+await client.sendCtcUrl({
+  phone: '+1234567890',
+  bodyText: 'Need help? Chat with us on WhatsApp!',
+  displayText: 'Chat Now',
+  url: 'https://wa.me/919999999999?text=Hi%20I%20need%20help',
+  footerText: 'We reply within 5 minutes',
+});
 ```
 
 ### Templates
@@ -78,13 +87,36 @@ const result = await client.sendTemplate({
 ### Broadcast
 
 ```typescript
+// Send to specific phone numbers
 const result = await client.broadcast({
   name: 'Summer Sale',
   templateName: 'summer_offer',
   templateLanguage: 'en_US',
   recipients: ['+1234567890', '+0987654321'],
+  templateVariables: { name: 'User', offer: '50% OFF' },
+});
+// { success: true, message: 'Template "summer_offer" processed: 20 sent, 5 failed', sent: 20, failed: 5 }
+
+// Send to contacts filtered by tags
+await client.broadcast({
+  name: 'Premium Users',
+  templateName: 'vip_offer',
+  templateVariables: { name: 'VIP User' },
+  audienceFilter: { tags: ['premium', 'vip'] },
+});
+
+// Broadcast from Excel/CSV file
+import { readFileSync } from 'fs';
+const file = new File([readFileSync('contacts.xlsx')], 'contacts.xlsx', { 
+  type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 
+});
+
+await client.broadcastFromSheet({
+  name: 'Bulk Broadcast',
+  templateName: 'offer',
+  templateVariables: { name: 'User' },
+  file,
 });
-// { success: true, message: 'Template "summer_offer" processed: 20 sent, 5 failed' }
 ```
 
 ### Wallet
@@ -92,11 +124,11 @@ const result = await client.broadcast({
 ```typescript
 // Check balance
 const balance = await client.getBalance();
-// { success: true, balance: 100, can_send: 100 }
+// { success: true, balance: 100, template_rate: 1, can_send: 100 }
 
 // Estimate cost before sending
 const estimate = await client.estimateCost(50);
-// { success: true, balance: 100, can_send: 100, estimated_templates: 50 }
+// { success: true, balance: 100, can_send: 100, estimated_templates: 50, estimated_cost: 50 }
 
 // Generate payment link (user opens link to pay)
 const link = await client.rechargeViaLink({ 
@@ -107,6 +139,10 @@ const link = await client.rechargeViaLink({
 // { success: true, link_url: 'https://cashfree.com/pay/...', order_amount: 500 }
 // User opens link_url and pays via Card/UPI
 
+// Verify payment after Cashfree redirect
+const verify = await client.verifyOrder('wallet_1234567890_abc123');
+// { success: true, status: 'PAID', balance: 500, message: '₹500 added to your wallet' }
+
 // Get transaction history
 const txns = await client.getTransactions(10, 0);
 // { success: true, transactions: [...] }
@@ -143,7 +179,7 @@ All methods return a simple response object. **No exceptions are thrown.**
 { success: true, sent_as: 'template', balance: 99 }
 
 // Broadcast
-{ success: true, message: 'Template "promo" processed: 20 sent, 10 skipped, 5 failed' }
+{ success: true, message: 'Template "promo" processed: 20 sent, 5 failed', sent: 20, failed: 5, refunded: 5 }
 ```
 
 ## Error Handling

package/dist/index.d.mts

@@ -24,6 +24,13 @@ interface SendDocumentOptions {
     filename?: string;
     caption?: string;
 }
+interface SendCtcUrlOptions {
+    phone: string;
+    bodyText: string;
+    displayText: string;
+    url: string;
+    footerText?: string;
+}
 interface SendTemplateOptions {
     phone: string;
     templateName: string;
@@ -59,6 +66,21 @@ interface ApiResponse {
 interface BroadcastResponse {
     success: boolean;
     message: string;
+    sent?: number;
+    failed?: number;
+    skipped?: number;
+    refunded?: number;
+}
+interface BroadcastSheetResponse {
+    success: boolean;
+    message: string;
+    total_rows?: number;
+    valid_recipients?: number;
+    new_contacts?: number;
+    sent?: number;
+    failed?: number;
+    skipped?: number;
+    refunded?: number;
 }
 interface CheckTemplateOptions {
     templateName: string;
@@ -88,15 +110,6 @@ interface WalletBalanceResponse {
     is_active?: boolean;
     message: string;
 }
-interface AddCreditsOptions {
-    amount: number;
-    description?: string;
-}
-interface AddCreditsResponse {
-    success: boolean;
-    balance?: number;
-    message: string;
-}
 interface Transaction {
     type: 'credit' | 'debit' | 'refund';
     amount: number;
@@ -141,6 +154,14 @@ interface EstimateCostResponse {
     template_rate?: number;
     can_send?: number;
     estimated_templates?: number;
+    estimated_cost?: number;
+    can_send_templates?: number;
+    message: string;
+}
+interface VerifyOrderResponse {
+    success: boolean;
+    status?: string;
+    balance?: number;
     message: string;
 }
 interface Broadcast {
@@ -180,14 +201,22 @@ declare class BTechWorksClient {
     sendPhoto(options: SendPhotoOptions): Promise<ApiResponse>;
     sendVideo(options: SendVideoOptions): Promise<ApiResponse>;
     sendDocument(options: SendDocumentOptions): Promise<ApiResponse>;
+    sendCtcUrl(options: SendCtcUrlOptions): Promise<ApiResponse>;
     sendTemplate(options: SendTemplateOptions): Promise<SendTemplateResponse>;
     broadcast(options: BroadcastOptions): Promise<BroadcastResponse>;
+    broadcastFromSheet(options: {
+        name: string;
+        templateName: string;
+        templateLanguage?: string;
+        templateVariables?: Record<string, string>;
+        file: File;
+    }): Promise<BroadcastSheetResponse>;
     getBalance(): Promise<WalletBalanceResponse>;
     estimateCost(count?: number): Promise<EstimateCostResponse>;
-    addCredits(options: AddCreditsOptions): Promise<AddCreditsResponse>;
     recharge(options: RechargeOptions): Promise<RechargeResponse>;
     rechargeViaLink(options: RechargeOptions): Promise<RechargeViaLinkResponse>;
+    verifyOrder(orderId: string): Promise<VerifyOrderResponse>;
     getTransactions(limit?: number, offset?: number): Promise<TransactionsResponse>;
 }
 
-export { type AddCreditsOptions, type AddCreditsResponse, type ApiResponse, BTechWorksClient, type BTechWorksConfig, type BroadcastOptions, type BroadcastResponse, type CheckTemplateOptions, type CheckTemplateResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendTemplateResponse, type SendVideoOptions, type TemplateVariable, type Transaction, type TransactionsResponse, type WalletBalanceResponse };
+export { type Analytics, type AnalyticsResponse, type ApiResponse, BTechWorksClient, type BTechWorksConfig, type Broadcast, type BroadcastOptions, type BroadcastResponse, type BroadcastSheetResponse, type CheckTemplateOptions, type CheckTemplateResponse, type EstimateCostResponse, type RechargeOptions, type RechargeResponse, type RechargeViaLinkResponse, type SendCtcUrlOptions, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendTemplateResponse, type SendVideoOptions, type TemplateVariable, type Transaction, type TransactionsResponse, type VerifyOrderResponse, type WalletBalanceResponse };

package/dist/index.d.ts

@@ -24,6 +24,13 @@ interface SendDocumentOptions {
     filename?: string;
     caption?: string;
 }
+interface SendCtcUrlOptions {
+    phone: string;
+    bodyText: string;
+    displayText: string;
+    url: string;
+    footerText?: string;
+}
 interface SendTemplateOptions {
     phone: string;
     templateName: string;
@@ -59,6 +66,21 @@ interface ApiResponse {
 interface BroadcastResponse {
     success: boolean;
     message: string;
+    sent?: number;
+    failed?: number;
+    skipped?: number;
+    refunded?: number;
+}
+interface BroadcastSheetResponse {
+    success: boolean;
+    message: string;
+    total_rows?: number;
+    valid_recipients?: number;
+    new_contacts?: number;
+    sent?: number;
+    failed?: number;
+    skipped?: number;
+    refunded?: number;
 }
 interface CheckTemplateOptions {
     templateName: string;
@@ -88,15 +110,6 @@ interface WalletBalanceResponse {
     is_active?: boolean;
     message: string;
 }
-interface AddCreditsOptions {
-    amount: number;
-    description?: string;
-}
-interface AddCreditsResponse {
-    success: boolean;
-    balance?: number;
-    message: string;
-}
 interface Transaction {
     type: 'credit' | 'debit' | 'refund';
     amount: number;
@@ -141,6 +154,14 @@ interface EstimateCostResponse {
     template_rate?: number;
     can_send?: number;
     estimated_templates?: number;
+    estimated_cost?: number;
+    can_send_templates?: number;
+    message: string;
+}
+interface VerifyOrderResponse {
+    success: boolean;
+    status?: string;
+    balance?: number;
     message: string;
 }
 interface Broadcast {
@@ -180,14 +201,22 @@ declare class BTechWorksClient {
     sendPhoto(options: SendPhotoOptions): Promise<ApiResponse>;
     sendVideo(options: SendVideoOptions): Promise<ApiResponse>;
     sendDocument(options: SendDocumentOptions): Promise<ApiResponse>;
+    sendCtcUrl(options: SendCtcUrlOptions): Promise<ApiResponse>;
     sendTemplate(options: SendTemplateOptions): Promise<SendTemplateResponse>;
     broadcast(options: BroadcastOptions): Promise<BroadcastResponse>;
+    broadcastFromSheet(options: {
+        name: string;
+        templateName: string;
+        templateLanguage?: string;
+        templateVariables?: Record<string, string>;
+        file: File;
+    }): Promise<BroadcastSheetResponse>;
     getBalance(): Promise<WalletBalanceResponse>;
     estimateCost(count?: number): Promise<EstimateCostResponse>;
-    addCredits(options: AddCreditsOptions): Promise<AddCreditsResponse>;
     recharge(options: RechargeOptions): Promise<RechargeResponse>;
     rechargeViaLink(options: RechargeOptions): Promise<RechargeViaLinkResponse>;
+    verifyOrder(orderId: string): Promise<VerifyOrderResponse>;
     getTransactions(limit?: number, offset?: number): Promise<TransactionsResponse>;
 }
 
-export { type AddCreditsOptions, type AddCreditsResponse, type ApiResponse, BTechWorksClient, type BTechWorksConfig, type BroadcastOptions, type BroadcastResponse, type CheckTemplateOptions, type CheckTemplateResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendTemplateResponse, type SendVideoOptions, type TemplateVariable, type Transaction, type TransactionsResponse, type WalletBalanceResponse };
+export { type Analytics, type AnalyticsResponse, type ApiResponse, BTechWorksClient, type BTechWorksConfig, type Broadcast, type BroadcastOptions, type BroadcastResponse, type BroadcastSheetResponse, type CheckTemplateOptions, type CheckTemplateResponse, type EstimateCostResponse, type RechargeOptions, type RechargeResponse, type RechargeViaLinkResponse, type SendCtcUrlOptions, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendTemplateResponse, type SendVideoOptions, type TemplateVariable, type Transaction, type TransactionsResponse, type VerifyOrderResponse, type WalletBalanceResponse };

package/dist/index.js

@@ -129,6 +129,18 @@ var BTechWorksClient = class {
       })
     });
   }
+  async sendCtcUrl(options) {
+    return this.request("/api/sdk/send-ctc-url", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        body_text: options.bodyText,
+        display_text: options.displayText,
+        url: options.url,
+        footer_text: options.footerText
+      })
+    });
+  }
   async sendTemplate(options) {
     return this.request("/api/sdk/send-template", {
       method: "POST",
@@ -154,6 +166,40 @@ var BTechWorksClient = class {
       })
     });
   }
+  async broadcastFromSheet(options) {
+    const formData = new FormData();
+    formData.append("name", options.name);
+    formData.append("template_name", options.templateName);
+    if (options.templateLanguage) formData.append("template_language", options.templateLanguage);
+    if (options.templateVariables) formData.append("template_variables", JSON.stringify(options.templateVariables));
+    formData.append("file", options.file);
+    const url = `${this.baseUrl}/api/sdk/broadcast-sheet`;
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await globalThis.fetch(url, {
+        method: "POST",
+        headers: {
+          "x-api-key": this.apiKey,
+          "x-secret-key": this.secretKey
+        },
+        body: formData,
+        signal: controller.signal
+      });
+      const data = await response.json();
+      return data;
+    } catch (error) {
+      if (error instanceof DOMException && error.name === "AbortError") {
+        return { success: false, message: "Request timeout" };
+      }
+      return {
+        success: false,
+        message: error instanceof Error ? error.message : "Unknown error"
+      };
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
   async getBalance() {
     return this.request("/api/sdk/wallet/balance", {
       method: "GET"
@@ -164,15 +210,6 @@ var BTechWorksClient = class {
       method: "GET"
     });
   }
-  async addCredits(options) {
-    return this.request("/api/sdk/wallet/add-credits", {
-      method: "POST",
-      body: JSON.stringify({
-        amount: options.amount,
-        description: options.description
-      })
-    });
-  }
   async recharge(options) {
     return this.request("/api/sdk/wallet/recharge", {
       method: "POST",
@@ -193,6 +230,11 @@ var BTechWorksClient = class {
       })
     });
   }
+  async verifyOrder(orderId) {
+    return this.request(`/api/sdk/wallet/verify-order?order_id=${encodeURIComponent(orderId)}`, {
+      method: "GET"
+    });
+  }
   async getTransactions(limit, offset) {
     const params = new URLSearchParams();
     if (limit) params.set("limit", limit.toString());

package/dist/index.mjs

@@ -103,6 +103,18 @@ var BTechWorksClient = class {
       })
     });
   }
+  async sendCtcUrl(options) {
+    return this.request("/api/sdk/send-ctc-url", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        body_text: options.bodyText,
+        display_text: options.displayText,
+        url: options.url,
+        footer_text: options.footerText
+      })
+    });
+  }
   async sendTemplate(options) {
     return this.request("/api/sdk/send-template", {
       method: "POST",
@@ -128,6 +140,40 @@ var BTechWorksClient = class {
       })
     });
   }
+  async broadcastFromSheet(options) {
+    const formData = new FormData();
+    formData.append("name", options.name);
+    formData.append("template_name", options.templateName);
+    if (options.templateLanguage) formData.append("template_language", options.templateLanguage);
+    if (options.templateVariables) formData.append("template_variables", JSON.stringify(options.templateVariables));
+    formData.append("file", options.file);
+    const url = `${this.baseUrl}/api/sdk/broadcast-sheet`;
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await globalThis.fetch(url, {
+        method: "POST",
+        headers: {
+          "x-api-key": this.apiKey,
+          "x-secret-key": this.secretKey
+        },
+        body: formData,
+        signal: controller.signal
+      });
+      const data = await response.json();
+      return data;
+    } catch (error) {
+      if (error instanceof DOMException && error.name === "AbortError") {
+        return { success: false, message: "Request timeout" };
+      }
+      return {
+        success: false,
+        message: error instanceof Error ? error.message : "Unknown error"
+      };
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
   async getBalance() {
     return this.request("/api/sdk/wallet/balance", {
       method: "GET"
@@ -138,15 +184,6 @@ var BTechWorksClient = class {
       method: "GET"
     });
   }
-  async addCredits(options) {
-    return this.request("/api/sdk/wallet/add-credits", {
-      method: "POST",
-      body: JSON.stringify({
-        amount: options.amount,
-        description: options.description
-      })
-    });
-  }
   async recharge(options) {
     return this.request("/api/sdk/wallet/recharge", {
       method: "POST",
@@ -167,6 +204,11 @@ var BTechWorksClient = class {
       })
     });
   }
+  async verifyOrder(orderId) {
+    return this.request(`/api/sdk/wallet/verify-order?order_id=${encodeURIComponent(orderId)}`, {
+      method: "GET"
+    });
+  }
   async getTransactions(limit, offset) {
     const params = new URLSearchParams();
     if (limit) params.set("limit", limit.toString());

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "btechworks-sdk",
-  "version": "1.0.3",
-  "description": "Official BatchWorks WhatsApp CRM SDK - Send messages, photos, videos, documents, templates, and broadcasts via API",
+  "version": "1.0.6",
+  "description": "Official BatchWorks WhatsApp CRM SDK - Send messages, photos, videos, documents, templates, broadcasts, and wallet management via API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",