@zapyapi/sdk 1.0.0-beta.6 → 1.0.0-beta.7

package/README.md

@@ -284,35 +284,70 @@ extractPhone('5511999999999@c.us'); // '5511999999999'
 
 ## Webhook Event Types
 
-The SDK provides types for webhook events:
+The SDK provides fully typed webhook events with discriminated unions for each message type:
 
 ```typescript
-import type {
-  WebhookEvent,
-  MessageWebhookEvent,
-  MessageAckWebhookEvent,
-  ConnectionWebhookEvent,
-  QRCodeWebhookEvent,
+import {
+  ZapyWebhookPayload,
+  ZapyEventTypes,
+  isTextMessage,
+  isImageMessage,
+  isVideoMessage,
+  isAudioMessage,
 } from '@zapyapi/sdk';
 
-function handleWebhook(event: WebhookEvent) {
-  switch (event.event) {
-    case 'message':
-      // event is MessageWebhookEvent
-      console.log(`New message from ${event.data.from}`);
+function handleWebhook(payload: ZapyWebhookPayload) {
+  console.log(`Event from instance: ${payload.instanceId}`);
+
+  switch (payload.event) {
+    case ZapyEventTypes.MESSAGE:
+      // payload.data is ZapyMessage (discriminated union)
+      const message = payload.data;
+
+      if (isTextMessage(message)) {
+        console.log(`Text: ${message.text}`);
+      } else if (isImageMessage(message)) {
+        console.log(`Image: ${message.url}, caption: ${message.caption}`);
+      } else if (isVideoMessage(message)) {
+        console.log(`Video: ${message.url}`);
+      } else if (isAudioMessage(message)) {
+        console.log(`Audio: ${message.url}, duration: ${message.duration}s`);
+      }
+      break;
+
+    case ZapyEventTypes.MESSAGE_STATUS:
+      console.log(`Message ${payload.data.messageId} status: ${payload.data.status}`);
       break;
-    case 'message.ack':
-      // event is MessageAckWebhookEvent
-      console.log(`Message ${event.data.messageId} status: ${event.data.ack}`);
+
+    case ZapyEventTypes.QR_CODE:
+      console.log(`QR Code received, attempt: ${payload.data.attempt}`);
       break;
-    case 'connection.update':
-      // event is ConnectionWebhookEvent
-      console.log(`Connection status: ${event.data.status}`);
+
+    case ZapyEventTypes.INSTANCE_STATUS:
+      console.log(`Instance status: ${payload.data.status}`);
       break;
   }
 }
 ```
 
+### Available Message Type Guards
+
+```typescript
+import {
+  isTextMessage,
+  isImageMessage,
+  isVideoMessage,
+  isAudioMessage,
+  isDocumentMessage,
+  isStickerMessage,
+  isLocationMessage,
+  isContactMessage,
+  isReactionMessage,
+  isPollMessage,
+  isMediaMessage, // matches any media type
+} from '@zapyapi/sdk';
+```
+
 ## Requirements
 
 - Node.js 18 or higher
@@ -328,6 +363,33 @@ const { ZapyClient } = require('@zapyapi/sdk');
 const client = new ZapyClient({ apiKey: 'your-api-key' });
 ```
 
+## Low-Level REST API Client
+
+For advanced use cases, the SDK also exports an auto-generated REST client with full type definitions from the OpenAPI spec:
+
+```typescript
+import { ZapyRestApi } from '@zapyapi/sdk';
+
+const api = new ZapyRestApi({
+  baseURL: 'https://api.zapyapi.com',
+  headers: {
+    'x-api-key': 'your-api-key',
+  },
+});
+
+// Direct REST calls with full type safety
+const response = await api.instances.managerInstancesControllerListInstances({
+  page: 1,
+  limit: 10,
+});
+
+// Send a message
+await api.sendMessage.sendMessageControllerSendTextMessage(
+  'my-instance',
+  { to: '5511999999999', text: 'Hello!' }
+);
+```
+
 ## License
 
 MIT