btechworks-sdk 1.0.0 → 1.0.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 BatchWorks
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 BatchWorks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -18,14 +18,13 @@ const client = new BTechWorksClient({
   secretKey: 'ws_your_secret_key_here',
 });
 
-// Send a text message - bas phone aur message do, baaki SDK sambhalega
 const result = await client.sendMessage({
   phone: '+1234567890',
   message: 'Hello from BTechWorks SDK!',
 });
 
 console.log(result);
-// { success: true, messageId: '...', whatsappMessageId: '...' }
+// { success: true, message: 'Message sent successfully' }
 ```
 
 ## Configuration
@@ -43,13 +42,14 @@ const client = new BTechWorksClient({
 
 ### sendMessage
 
-Send a text message to a phone number. Contact and conversation are auto-created if they don't exist.
+Send a text message to a phone number. Contact and conversation are auto-created.
 
 ```typescript
 const result = await client.sendMessage({
   phone: '+1234567890',
   message: 'Hello World!',
 });
+// { success: true, message: 'Message sent successfully' }
 ```
 
 ### sendPhoto
@@ -62,6 +62,7 @@ const result = await client.sendPhoto({
   imageUrl: 'https://example.com/photo.jpg',
   caption: 'Check out this photo!',
 });
+// { success: true, message: 'Photo sent successfully' }
 ```
 
 ### sendVideo
@@ -74,6 +75,7 @@ const result = await client.sendVideo({
   videoUrl: 'https://example.com/video.mp4',
   caption: 'Watch this video!',
 });
+// { success: true, message: 'Video sent successfully' }
 ```
 
 ### sendDocument
@@ -87,6 +89,7 @@ const result = await client.sendDocument({
   filename: 'invoice.pdf',
   caption: 'Your invoice for this month',
 });
+// { success: true, message: 'Document sent successfully' }
 ```
 
 ### sendTemplate
@@ -101,6 +104,7 @@ const result = await client.sendTemplate({
   templateLanguage: 'en_US',
   templateParams: ['John', 'Order #12345'],
 });
+// { success: true, message: 'Template sent successfully' }
 
 // Template with header media and button params
 const result2 = await client.sendTemplate({
@@ -108,14 +112,9 @@ const result2 = await client.sendTemplate({
   templateName: 'promo_template',
   templateLanguage: 'en_US',
   templateMessageParams: {
-    header: {
-      type: 'image',
-      url: 'https://example.com/promo.jpg',
-    },
+    header: { type: 'image', url: 'https://example.com/promo.jpg' },
     body: ['John', '50%'],
-    buttons: [
-      { type: 'url', suffix: 'promo50' },
-    ],
+    buttons: [{ type: 'url', suffix: 'promo50' }],
   },
 });
 ```
@@ -132,6 +131,7 @@ const result = await client.broadcast({
   templateVariables: { code: 'SUMMER50' },
   recipients: ['+1234567890', '+0987654321', '+1122334455'],
 });
+// { success: true, message: 'Template "summer_sale" processed: 20 sent, 5 failed' }
 
 // Or use audience filter by tags
 const result2 = await client.broadcast({
@@ -140,6 +140,22 @@ const result2 = await client.broadcast({
   recipients: [],
   audienceFilter: { tags: ['vip', 'premium'] },
 });
+// { success: true, message: 'Template "vip_offer" processed: 50 sent, 10 skipped, 3 failed' }
+```
+
+## Response Format
+
+All methods return a simple response:
+
+```typescript
+// Single message
+{ success: true, message: 'Message sent successfully' }
+
+// Broadcast
+{ success: true, message: 'Template "promo" processed: 20 sent, 10 skipped, 5 failed' }
+
+// Error (throws BTechWorksError)
+{ success: false, message: 'Invalid phone number format' }
 ```
 
 ## Error Handling
@@ -150,15 +166,11 @@ All methods throw `BTechWorksError` on failure:
 import { BTechWorksClient, BTechWorksError } from 'btechworks-sdk';
 
 try {
-  await client.sendMessage({
-    phone: '+1234567890',
-    message: 'Hello!',
-  });
+  await client.sendMessage({ phone: '+1234567890', message: 'Hello!' });
 } catch (error) {
   if (error instanceof BTechWorksError) {
     console.log(error.message);      // Error message
     console.log(error.statusCode);   // HTTP status code
-    console.log(error.details);      // Additional error details
   }
 }
 ```
@@ -172,7 +184,7 @@ try {
 ## Getting API Keys
 
 1. Login to your BTechWorks dashboard
-2. Go to Settings > API Keys
+2. Go to Settings > API Key
 3. Click "Create API Key"
 4. Copy both the API Key and Secret Key (secret is shown only once)
 

package/dist/index.d.mts

@@ -54,21 +54,11 @@ interface BroadcastOptions {
 }
 interface ApiResponse {
     success: boolean;
-    message_id?: string;
-    whatsapp_message_id?: string;
-    error?: string;
+    message: string;
 }
 interface BroadcastResponse {
     success: boolean;
-    broadcast_id?: string;
-    total_recipients?: number;
-    status?: string;
-    error?: string;
-}
-interface ApiError {
-    error: string;
-    statusCode: number;
-    details?: Record<string, unknown>;
+    message: string;
 }
 
 declare class BTechWorksError extends Error {
@@ -91,4 +81,4 @@ declare class BTechWorksClient {
     broadcast(options: BroadcastOptions): Promise<BroadcastResponse>;
 }
 
-export { type ApiError, type ApiResponse, BTechWorksClient, type BTechWorksConfig, BTechWorksError, type BroadcastOptions, type BroadcastResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendVideoOptions };
+export { type ApiResponse, BTechWorksClient, type BTechWorksConfig, BTechWorksError, type BroadcastOptions, type BroadcastResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendVideoOptions };

package/dist/index.d.ts

@@ -54,21 +54,11 @@ interface BroadcastOptions {
 }
 interface ApiResponse {
     success: boolean;
-    message_id?: string;
-    whatsapp_message_id?: string;
-    error?: string;
+    message: string;
 }
 interface BroadcastResponse {
     success: boolean;
-    broadcast_id?: string;
-    total_recipients?: number;
-    status?: string;
-    error?: string;
-}
-interface ApiError {
-    error: string;
-    statusCode: number;
-    details?: Record<string, unknown>;
+    message: string;
 }
 
 declare class BTechWorksError extends Error {
@@ -91,4 +81,4 @@ declare class BTechWorksClient {
     broadcast(options: BroadcastOptions): Promise<BroadcastResponse>;
 }
 
-export { type ApiError, type ApiResponse, BTechWorksClient, type BTechWorksConfig, BTechWorksError, type BroadcastOptions, type BroadcastResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendVideoOptions };
+export { type ApiResponse, BTechWorksClient, type BTechWorksConfig, BTechWorksError, type BroadcastOptions, type BroadcastResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendVideoOptions };

package/dist/index.js

@@ -67,7 +67,7 @@ var BTechWorksClient = class {
       const data = await response.json();
       if (!response.ok) {
         throw new BTechWorksError(
-          data.error || `Request failed with status ${response.status}`,
+          data.message || data.error || `Request failed with status ${response.status}`,
           response.status,
           data
         );
@@ -87,21 +87,16 @@ var BTechWorksClient = class {
     }
   }
   async sendMessage(options) {
-    const data = await this.request("/api/sdk/send-message", {
+    return this.request("/api/sdk/send-message", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
         message: options.message
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendPhoto(options) {
-    const data = await this.request("/api/sdk/send-photo", {
+    return this.request("/api/sdk/send-photo", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -109,14 +104,9 @@ var BTechWorksClient = class {
         caption: options.caption
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendVideo(options) {
-    const data = await this.request("/api/sdk/send-video", {
+    return this.request("/api/sdk/send-video", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -124,14 +114,9 @@ var BTechWorksClient = class {
         caption: options.caption
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendDocument(options) {
-    const data = await this.request("/api/sdk/send-document", {
+    return this.request("/api/sdk/send-document", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -140,14 +125,9 @@ var BTechWorksClient = class {
         caption: options.caption
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendTemplate(options) {
-    const data = await this.request("/api/sdk/send-template", {
+    return this.request("/api/sdk/send-template", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -157,14 +137,9 @@ var BTechWorksClient = class {
         template_message_params: options.templateMessageParams
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async broadcast(options) {
-    const data = await this.request("/api/sdk/broadcast", {
+    return this.request("/api/sdk/broadcast", {
       method: "POST",
       body: JSON.stringify({
         name: options.name,
@@ -175,12 +150,6 @@ var BTechWorksClient = class {
         audience_filter: options.audienceFilter
       })
     });
-    return {
-      success: data.success,
-      broadcast_id: data.broadcast_id,
-      total_recipients: data.total_recipients,
-      status: data.status
-    };
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -40,7 +40,7 @@ var BTechWorksClient = class {
       const data = await response.json();
       if (!response.ok) {
         throw new BTechWorksError(
-          data.error || `Request failed with status ${response.status}`,
+          data.message || data.error || `Request failed with status ${response.status}`,
           response.status,
           data
         );
@@ -60,21 +60,16 @@ var BTechWorksClient = class {
     }
   }
   async sendMessage(options) {
-    const data = await this.request("/api/sdk/send-message", {
+    return this.request("/api/sdk/send-message", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
         message: options.message
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendPhoto(options) {
-    const data = await this.request("/api/sdk/send-photo", {
+    return this.request("/api/sdk/send-photo", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -82,14 +77,9 @@ var BTechWorksClient = class {
         caption: options.caption
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendVideo(options) {
-    const data = await this.request("/api/sdk/send-video", {
+    return this.request("/api/sdk/send-video", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -97,14 +87,9 @@ var BTechWorksClient = class {
         caption: options.caption
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendDocument(options) {
-    const data = await this.request("/api/sdk/send-document", {
+    return this.request("/api/sdk/send-document", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -113,14 +98,9 @@ var BTechWorksClient = class {
         caption: options.caption
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async sendTemplate(options) {
-    const data = await this.request("/api/sdk/send-template", {
+    return this.request("/api/sdk/send-template", {
       method: "POST",
       body: JSON.stringify({
         phone: options.phone,
@@ -130,14 +110,9 @@ var BTechWorksClient = class {
         template_message_params: options.templateMessageParams
       })
     });
-    return {
-      success: data.success,
-      message_id: data.message_id,
-      whatsapp_message_id: data.whatsapp_message_id
-    };
   }
   async broadcast(options) {
-    const data = await this.request("/api/sdk/broadcast", {
+    return this.request("/api/sdk/broadcast", {
       method: "POST",
       body: JSON.stringify({
         name: options.name,
@@ -148,12 +123,6 @@ var BTechWorksClient = class {
         audience_filter: options.audienceFilter
       })
     });
-    return {
-      success: data.success,
-      broadcast_id: data.broadcast_id,
-      total_recipients: data.total_recipients,
-      status: data.status
-    };
   }
 };
 export {

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "btechworks-sdk",
-  "version": "1.0.0",
-  "description": "Official BatchWorks WhatsApp CRM SDK - Send messages, photos, videos, documents, templates, and broadcasts via API",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
-  },
-  "keywords": [
-    "whatsapp",
-    "crm",
-    "api",
-    "sdk",
-    "messaging",
-    "broadcast",
-    "template",
-    "batchworks"
-  ],
-  "author": "BatchWorks",
-  "license": "MIT",
-  "devDependencies": {
-    "tsup": "^8.0.0",
-    "typescript": "^5.3.0"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  }
-}
+{
+  "name": "btechworks-sdk",
+  "version": "1.0.1",
+  "description": "Official BatchWorks WhatsApp CRM SDK - Send messages, photos, videos, documents, templates, and broadcasts via API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+  },
+  "keywords": [
+    "whatsapp",
+    "crm",
+    "api",
+    "sdk",
+    "messaging",
+    "broadcast",
+    "template",
+    "batchworks"
+  ],
+  "author": "BatchWorks",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}