@zapyapi/sdk 1.0.0-beta.2 → 1.0.0-beta.4

package/index.cjs

@@ -3,7 +3,7 @@
 var axios = require('axios');
 
 /** SDK version - auto-generated from package.json */
-const SDK_VERSION = '1.0.0-beta.2';
+const SDK_VERSION = '1.0.0-beta.4';
 
 /**
  * Custom error classes for @zapyapi/sdk
@@ -428,6 +428,121 @@ class MessagesResource extends BaseResource {
       this.handleError(error);
     }
   }
+  /**
+   * Send a location message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Location message options
+   * @returns Message response with ID and status
+   *
+   * @example
+   * await client.messages.sendLocation('my-instance', {
+   *   to: '5511999999999',
+   *   latitude: -23.5505,
+   *   longitude: -46.6333,
+   *   name: 'São Paulo',
+   *   address: 'São Paulo, Brazil'
+   * });
+   */
+  async sendLocation(instanceId, options) {
+    try {
+      const response = await this.http.post(`/message/${instanceId}/location`, {
+        to: options.to,
+        latitude: options.latitude,
+        longitude: options.longitude,
+        name: options.name,
+        address: options.address,
+        quoteMessageId: options.quotedMessageId
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a contact card message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Contact message options
+   * @returns Message response with ID and status
+   *
+   * @example
+   * await client.messages.sendContact('my-instance', {
+   *   to: '5511999999999',
+   *   contact: {
+   *     fullName: 'John Doe',
+   *     phoneNumber: '+5511988887777',
+   *     organization: 'Acme Inc'
+   *   }
+   * });
+   */
+  async sendContact(instanceId, options) {
+    try {
+      const response = await this.http.post(`/message/${instanceId}/contact`, {
+        to: options.to,
+        contact: options.contact,
+        quoteMessageId: options.quotedMessageId
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a sticker message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Sticker message options
+   * @returns Message response with ID and status
+   *
+   * @example
+   * await client.messages.sendSticker('my-instance', {
+   *   to: '5511999999999',
+   *   url: 'https://example.com/sticker.webp'
+   * });
+   */
+  async sendSticker(instanceId, options) {
+    try {
+      const response = await this.http.post(`/message/${instanceId}/sticker`, {
+        to: options.to,
+        url: options.url,
+        base64: options.base64,
+        quoteMessageId: options.quotedMessageId
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a reaction to a message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Reaction options
+   *
+   * @example
+   * // Add a reaction
+   * await client.messages.sendReaction('my-instance', {
+   *   messageId: 'ABC123...',
+   *   reaction: '👍'
+   * });
+   *
+   * // Remove a reaction
+   * await client.messages.sendReaction('my-instance', {
+   *   messageId: 'ABC123...',
+   *   reaction: ''
+   * });
+   */
+  async sendReaction(instanceId, options) {
+    try {
+      await this.http.post(`/message/${instanceId}/reaction`, {
+        messageId: options.messageId,
+        reaction: options.reaction
+      });
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
 }
 
 /**
@@ -691,6 +806,155 @@ class InstancesResource extends BaseResource {
       this.handleError(error);
     }
   }
+  /**
+   * Check if phone numbers are registered on WhatsApp
+   *
+   * This method verifies if the provided phone numbers are registered on WhatsApp.
+   * Useful for validating contacts before sending messages.
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param numbers - Array of phone numbers to check (with country code, e.g., "5511999999999")
+   * @returns Results indicating which numbers are registered on WhatsApp
+   *
+   * @example
+   * const result = await client.instances.checkNumbers('my-instance', [
+   *   '5511999999999',
+   *   '5521888888888'
+   * ]);
+   *
+   * for (const check of result.results) {
+   *   if (check.exists) {
+   *     console.log(`${check.number} is on WhatsApp (JID: ${check.jid})`);
+   *   } else {
+   *     console.log(`${check.number} is NOT on WhatsApp`);
+   *   }
+   * }
+   */
+  async checkNumbers(instanceId, numbers) {
+    try {
+      const response = await this.http.post(`/instances/${instanceId}/check-numbers`, {
+        numbers
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a presence update (typing indicator, online status, etc.)
+   *
+   * Use this to show typing indicators or update online status for a contact.
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param options - Presence options
+   *
+   * @example
+   * // Show typing indicator
+   * await client.instances.sendPresence('my-instance', {
+   *   to: '5511999999999',
+   *   presence: 'composing'
+   * });
+   *
+   * // Show recording audio indicator
+   * await client.instances.sendPresence('my-instance', {
+   *   to: '5511999999999',
+   *   presence: 'recording'
+   * });
+   *
+   * // Stop typing indicator
+   * await client.instances.sendPresence('my-instance', {
+   *   to: '5511999999999',
+   *   presence: 'paused'
+   * });
+   */
+  async sendPresence(instanceId, options) {
+    try {
+      await this.http.post(`/instances/${instanceId}/presence`, {
+        to: options.to,
+        presence: options.presence
+      });
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Get profile picture URL for a contact
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param phone - Phone number or JID of the contact
+   * @returns Profile picture response with URL (null if not available)
+   *
+   * @example
+   * const result = await client.instances.getProfilePicture('my-instance', '5511999999999');
+   * if (result.url) {
+   *   console.log('Profile picture:', result.url);
+   * } else {
+   *   console.log('No profile picture available');
+   * }
+   */
+  async getProfilePicture(instanceId, phone) {
+    try {
+      const response = await this.http.get(`/instances/${instanceId}/contacts/${phone}/profile-picture`);
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Block a contact
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param phone - Phone number or JID of the contact to block
+   *
+   * @example
+   * await client.instances.blockContact('my-instance', '5511999999999');
+   */
+  async blockContact(instanceId, phone) {
+    try {
+      await this.http.post(`/instances/${instanceId}/contacts/${phone}/block`);
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Unblock a contact
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param phone - Phone number or JID of the contact to unblock
+   *
+   * @example
+   * await client.instances.unblockContact('my-instance', '5511999999999');
+   */
+  async unblockContact(instanceId, phone) {
+    try {
+      await this.http.delete(`/instances/${instanceId}/contacts/${phone}/block`);
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Get group metadata
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param groupId - Group JID (e.g., "120363123456789012@g.us")
+   * @returns Group metadata including participants
+   *
+   * @example
+   * const metadata = await client.instances.getGroupMetadata('my-instance', '120363123456789012@g.us');
+   * console.log(`Group: ${metadata.subject}`);
+   * console.log(`Participants: ${metadata.participants.length}`);
+   * for (const p of metadata.participants) {
+   *   console.log(`  - ${p.id} (${p.admin || 'member'})`);
+   * }
+   */
+  async getGroupMetadata(instanceId, groupId) {
+    try {
+      const response = await this.http.get(`/instances/${instanceId}/groups/${groupId}`);
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
 }
 
 /**
@@ -845,7 +1109,9 @@ const WebhookEventType = {
   /** Contact information updated */
   CONTACT_UPDATED: 'contact-updated',
   /** Duplicate contacts merged */
-  CONTACT_DEDUPLICATED: 'contact-deduplicated'
+  CONTACT_DEDUPLICATED: 'contact-deduplicated',
+  /** Instance status changed (connected, disconnected, etc.) */
+  INSTANCE_STATUS: 'instance-status'
 };
 /**
  * Instance status values

package/index.js

@@ -1,7 +1,7 @@
 import axios from 'axios';
 
 /** SDK version - auto-generated from package.json */
-const SDK_VERSION = '1.0.0-beta.2';
+const SDK_VERSION = '1.0.0-beta.4';
 
 /**
  * Custom error classes for @zapyapi/sdk
@@ -426,6 +426,121 @@ class MessagesResource extends BaseResource {
       this.handleError(error);
     }
   }
+  /**
+   * Send a location message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Location message options
+   * @returns Message response with ID and status
+   *
+   * @example
+   * await client.messages.sendLocation('my-instance', {
+   *   to: '5511999999999',
+   *   latitude: -23.5505,
+   *   longitude: -46.6333,
+   *   name: 'São Paulo',
+   *   address: 'São Paulo, Brazil'
+   * });
+   */
+  async sendLocation(instanceId, options) {
+    try {
+      const response = await this.http.post(`/message/${instanceId}/location`, {
+        to: options.to,
+        latitude: options.latitude,
+        longitude: options.longitude,
+        name: options.name,
+        address: options.address,
+        quoteMessageId: options.quotedMessageId
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a contact card message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Contact message options
+   * @returns Message response with ID and status
+   *
+   * @example
+   * await client.messages.sendContact('my-instance', {
+   *   to: '5511999999999',
+   *   contact: {
+   *     fullName: 'John Doe',
+   *     phoneNumber: '+5511988887777',
+   *     organization: 'Acme Inc'
+   *   }
+   * });
+   */
+  async sendContact(instanceId, options) {
+    try {
+      const response = await this.http.post(`/message/${instanceId}/contact`, {
+        to: options.to,
+        contact: options.contact,
+        quoteMessageId: options.quotedMessageId
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a sticker message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Sticker message options
+   * @returns Message response with ID and status
+   *
+   * @example
+   * await client.messages.sendSticker('my-instance', {
+   *   to: '5511999999999',
+   *   url: 'https://example.com/sticker.webp'
+   * });
+   */
+  async sendSticker(instanceId, options) {
+    try {
+      const response = await this.http.post(`/message/${instanceId}/sticker`, {
+        to: options.to,
+        url: options.url,
+        base64: options.base64,
+        quoteMessageId: options.quotedMessageId
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a reaction to a message
+   *
+   * @param instanceId - Instance ID
+   * @param options - Reaction options
+   *
+   * @example
+   * // Add a reaction
+   * await client.messages.sendReaction('my-instance', {
+   *   messageId: 'ABC123...',
+   *   reaction: '👍'
+   * });
+   *
+   * // Remove a reaction
+   * await client.messages.sendReaction('my-instance', {
+   *   messageId: 'ABC123...',
+   *   reaction: ''
+   * });
+   */
+  async sendReaction(instanceId, options) {
+    try {
+      await this.http.post(`/message/${instanceId}/reaction`, {
+        messageId: options.messageId,
+        reaction: options.reaction
+      });
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
 }
 
 /**
@@ -689,6 +804,155 @@ class InstancesResource extends BaseResource {
       this.handleError(error);
     }
   }
+  /**
+   * Check if phone numbers are registered on WhatsApp
+   *
+   * This method verifies if the provided phone numbers are registered on WhatsApp.
+   * Useful for validating contacts before sending messages.
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param numbers - Array of phone numbers to check (with country code, e.g., "5511999999999")
+   * @returns Results indicating which numbers are registered on WhatsApp
+   *
+   * @example
+   * const result = await client.instances.checkNumbers('my-instance', [
+   *   '5511999999999',
+   *   '5521888888888'
+   * ]);
+   *
+   * for (const check of result.results) {
+   *   if (check.exists) {
+   *     console.log(`${check.number} is on WhatsApp (JID: ${check.jid})`);
+   *   } else {
+   *     console.log(`${check.number} is NOT on WhatsApp`);
+   *   }
+   * }
+   */
+  async checkNumbers(instanceId, numbers) {
+    try {
+      const response = await this.http.post(`/instances/${instanceId}/check-numbers`, {
+        numbers
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Send a presence update (typing indicator, online status, etc.)
+   *
+   * Use this to show typing indicators or update online status for a contact.
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param options - Presence options
+   *
+   * @example
+   * // Show typing indicator
+   * await client.instances.sendPresence('my-instance', {
+   *   to: '5511999999999',
+   *   presence: 'composing'
+   * });
+   *
+   * // Show recording audio indicator
+   * await client.instances.sendPresence('my-instance', {
+   *   to: '5511999999999',
+   *   presence: 'recording'
+   * });
+   *
+   * // Stop typing indicator
+   * await client.instances.sendPresence('my-instance', {
+   *   to: '5511999999999',
+   *   presence: 'paused'
+   * });
+   */
+  async sendPresence(instanceId, options) {
+    try {
+      await this.http.post(`/instances/${instanceId}/presence`, {
+        to: options.to,
+        presence: options.presence
+      });
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Get profile picture URL for a contact
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param phone - Phone number or JID of the contact
+   * @returns Profile picture response with URL (null if not available)
+   *
+   * @example
+   * const result = await client.instances.getProfilePicture('my-instance', '5511999999999');
+   * if (result.url) {
+   *   console.log('Profile picture:', result.url);
+   * } else {
+   *   console.log('No profile picture available');
+   * }
+   */
+  async getProfilePicture(instanceId, phone) {
+    try {
+      const response = await this.http.get(`/instances/${instanceId}/contacts/${phone}/profile-picture`);
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Block a contact
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param phone - Phone number or JID of the contact to block
+   *
+   * @example
+   * await client.instances.blockContact('my-instance', '5511999999999');
+   */
+  async blockContact(instanceId, phone) {
+    try {
+      await this.http.post(`/instances/${instanceId}/contacts/${phone}/block`);
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Unblock a contact
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param phone - Phone number or JID of the contact to unblock
+   *
+   * @example
+   * await client.instances.unblockContact('my-instance', '5511999999999');
+   */
+  async unblockContact(instanceId, phone) {
+    try {
+      await this.http.delete(`/instances/${instanceId}/contacts/${phone}/block`);
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+  /**
+   * Get group metadata
+   *
+   * @param instanceId - Instance ID (must be connected)
+   * @param groupId - Group JID (e.g., "120363123456789012@g.us")
+   * @returns Group metadata including participants
+   *
+   * @example
+   * const metadata = await client.instances.getGroupMetadata('my-instance', '120363123456789012@g.us');
+   * console.log(`Group: ${metadata.subject}`);
+   * console.log(`Participants: ${metadata.participants.length}`);
+   * for (const p of metadata.participants) {
+   *   console.log(`  - ${p.id} (${p.admin || 'member'})`);
+   * }
+   */
+  async getGroupMetadata(instanceId, groupId) {
+    try {
+      const response = await this.http.get(`/instances/${instanceId}/groups/${groupId}`);
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
 }
 
 /**
@@ -843,7 +1107,9 @@ const WebhookEventType = {
   /** Contact information updated */
   CONTACT_UPDATED: 'contact-updated',
   /** Duplicate contacts merged */
-  CONTACT_DEDUPLICATED: 'contact-deduplicated'
+  CONTACT_DEDUPLICATED: 'contact-deduplicated',
+  /** Instance status changed (connected, disconnected, etc.) */
+  INSTANCE_STATUS: 'instance-status'
 };
 /**
  * Instance status values

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapyapi/sdk",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.4",
   "description": "Official TypeScript SDK for ZapyAPI - WhatsApp API",
   "type": "module",
   "main": "./index.cjs",