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

package/src/types/webhook-events.types.d.ts

@@ -1,257 +0,0 @@
-/**
- * Webhook event type definitions
- * Types for webhook payloads sent by ZapyAPI
- */
-import type { MessageType, MessageAckStatus, ConnectionStatus, InstanceStatus, WebhookEventType as WebhookEventTypeEnum } from './enums';
-/**
- * Re-export the enum type for convenience
- */
-export type WebhookEventType = WebhookEventTypeEnum;
-/**
- * Base webhook event payload
- * All webhook events include these fields
- */
-export interface WebhookEventBase<T extends WebhookEventType = WebhookEventType> {
-    /** Event type identifier */
-    event: T;
-    /** Instance ID that generated the event */
-    instanceId: string;
-}
-/**
- * Message sender/recipient info
- */
-export interface MessageParticipant {
-    /** WhatsApp ID (e.g., "5511999999999@c.us") */
-    id: string;
-    /** Phone number (e.g., "5511999999999") */
-    phone: string;
-    /** Display name if available */
-    name?: string;
-    /** Push name (user's WhatsApp name) */
-    pushName?: string;
-}
-/**
- * Media information in messages
- */
-export interface MediaInfo {
-    /** MIME type of the media */
-    mimeType: string;
-    /** File name if available */
-    fileName?: string;
-    /** File size in bytes */
-    fileSize?: number;
-    /** Media URL (temporary, expires) */
-    url?: string;
-}
-/**
- * Message webhook event data
- */
-export interface MessageEventData {
-    /** WhatsApp message ID */
-    messageId: string;
-    /** Message sender */
-    from: MessageParticipant;
-    /** Message recipient (your number/instance) */
-    to: MessageParticipant;
-    /** Message content type */
-    type: MessageType;
-    /** Text content (for text messages) */
-    text?: string;
-    /** Caption (for media messages) */
-    caption?: string;
-    /** Media information (for media messages) */
-    media?: MediaInfo;
-    /** Whether this is a group message */
-    isGroup: boolean;
-    /** Group participant who sent the message (for group messages) */
-    participant?: MessageParticipant;
-    /** ID of quoted/replied message */
-    quotedMessageId?: string;
-    /** Message timestamp (Unix ms) */
-    timestamp: number;
-    /** Whether this is a forwarded message */
-    isForwarded?: boolean;
-    /** Whether this is a broadcast message */
-    isBroadcast?: boolean;
-}
-/**
- * Message webhook event
- */
-export interface MessageWebhookEvent extends WebhookEventBase<'message'> {
-    data: MessageEventData;
-}
-/**
- * Message status update event data
- */
-export interface MessageStatusEventData {
-    /** WhatsApp message ID */
-    messageId: string;
-    /** New acknowledgment status */
-    ack: MessageAckStatus;
-    /** Sender of the original message */
-    from: string;
-    /** Recipient of the original message */
-    to: string;
-    /** Timestamp of status update (Unix ms) */
-    timestamp: number;
-}
-/**
- * Message acknowledgment/status webhook event
- */
-export interface MessageAckWebhookEvent extends WebhookEventBase<'message-status'> {
-    data: MessageStatusEventData;
-}
-/**
- * QR code update event data
- */
-export interface QRCodeEventData {
-    /** QR code as base64 data URL */
-    qrCode: string;
-    /** QR code generation attempt number */
-    attempt: number;
-    /** Expiration timestamp (Unix ms) */
-    expiresAt: number;
-}
-/**
- * QR code update webhook event
- */
-export interface QRCodeWebhookEvent extends WebhookEventBase<'qr-code'> {
-    data: QRCodeEventData;
-}
-/**
- * Contact information
- */
-export interface ContactInfo {
-    /** WhatsApp ID */
-    id: string;
-    /** Phone number */
-    phone: string;
-    /** Contact name */
-    name?: string;
-    /** Push name (WhatsApp display name) */
-    pushName?: string;
-    /** Profile picture URL */
-    profilePicUrl?: string;
-    /** Whether this is a business account */
-    isBusiness?: boolean;
-}
-/**
- * Contact created event data
- */
-export interface ContactCreatedEventData {
-    /** The new contact */
-    contact: ContactInfo;
-}
-/**
- * Contact created webhook event
- */
-export interface ContactCreatedWebhookEvent extends WebhookEventBase<'contact-created'> {
-    data: ContactCreatedEventData;
-}
-/**
- * Contact updated event data
- */
-export interface ContactUpdatedEventData {
-    /** The updated contact */
-    contact: ContactInfo;
-    /** Fields that were updated */
-    updatedFields: string[];
-}
-/**
- * Contact updated webhook event
- */
-export interface ContactUpdatedWebhookEvent extends WebhookEventBase<'contact-updated'> {
-    data: ContactUpdatedEventData;
-}
-/**
- * Contact deduplicated event data
- */
-export interface ContactDeduplicatedEventData {
-    /** The primary contact that was kept */
-    primaryContact: ContactInfo;
-    /** The duplicate contact that was merged */
-    duplicateContact: ContactInfo;
-}
-/**
- * Contact deduplicated webhook event
- */
-export interface ContactDeduplicatedWebhookEvent extends WebhookEventBase<'contact-deduplicated'> {
-    data: ContactDeduplicatedEventData;
-}
-/**
- * Instance status change event data
- */
-export interface InstanceStatusEventData {
-    /** Instance ID */
-    instanceId: string;
-    /** Current status */
-    status: InstanceStatus;
-    /** Previous status before this change */
-    previousStatus?: InstanceStatus;
-    /** Timestamp of status change (Unix ms) */
-    timestamp: number;
-    /** Reason for status change */
-    reason?: string;
-    /** Connected WhatsApp number (if available) */
-    connectedNumber?: string;
-}
-/**
- * Instance status change webhook event
- */
-export interface InstanceStatusWebhookEvent extends WebhookEventBase<'instance-status'> {
-    data: InstanceStatusEventData;
-}
-/**
- * Connection status update event data
- * @deprecated Use InstanceStatusEventData instead
- */
-export interface ConnectionEventData {
-    /** Connection status */
-    status: ConnectionStatus;
-    /** Reason for status change */
-    reason?: string;
-}
-/**
- * Connection status webhook event
- * @deprecated Use InstanceStatusWebhookEvent instead
- */
-export interface ConnectionWebhookEvent {
-    event: 'connection.update';
-    instanceId: string;
-    data: ConnectionEventData;
-}
-/**
- * Union type for all webhook events
- *
- * @example
- * ```typescript
- * import { WebhookEvent, WebhookEventType } from '@zapyapi/sdk';
- *
- * function handleWebhook(event: WebhookEvent) {
- *   switch (event.event) {
- *     case 'message':
- *       console.log('New message:', event.data.text);
- *       break;
- *     case 'message-status':
- *       console.log('Status update:', event.data.ack);
- *       break;
- *   }
- * }
- * ```
- */
-export type WebhookEvent = MessageWebhookEvent | MessageAckWebhookEvent | QRCodeWebhookEvent | ContactCreatedWebhookEvent | ContactUpdatedWebhookEvent | ContactDeduplicatedWebhookEvent | InstanceStatusWebhookEvent;
-/** Type guard for message events */
-export declare function isMessageEvent(event: WebhookEvent): event is MessageWebhookEvent;
-/** Type guard for message status events */
-export declare function isMessageStatusEvent(event: WebhookEvent): event is MessageAckWebhookEvent;
-/** Type guard for QR code events */
-export declare function isQRCodeEvent(event: WebhookEvent): event is QRCodeWebhookEvent;
-/** Type guard for contact created events */
-export declare function isContactCreatedEvent(event: WebhookEvent): event is ContactCreatedWebhookEvent;
-/** Type guard for contact updated events */
-export declare function isContactUpdatedEvent(event: WebhookEvent): event is ContactUpdatedWebhookEvent;
-/** Type guard for contact deduplicated events */
-export declare function isContactDeduplicatedEvent(event: WebhookEvent): event is ContactDeduplicatedWebhookEvent;
-/** Type guard for instance status events */
-export declare function isInstanceStatusEvent(event: WebhookEvent): event is InstanceStatusWebhookEvent;
-//# sourceMappingURL=webhook-events.types.d.ts.map

package/src/types/webhook-events.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"webhook-events.types.d.ts","sourceRoot":"","sources":["../../../../../libs/sdk/src/types/webhook-events.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,IAAI,oBAAoB,EACzC,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAEpD;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAC7E,4BAA4B;IAC5B,KAAK,EAAE,CAAC,CAAC;IACT,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,IAAI,EAAE,kBAAkB,CAAC;IACzB,+CAA+C;IAC/C,EAAE,EAAE,kBAAkB,CAAC;IACvB,2BAA2B;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,kEAAkE;IAClE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,mCAAmC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB,CAAC,SAAS,CAAC;IACtE,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,GAAG,EAAE,gBAAgB,CAAC;IACtB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB,CAAC,gBAAgB,CAAC;IAChF,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAMD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB,CAAC,SAAS,CAAC;IACrE,IAAI,EAAE,eAAe,CAAC;CACvB;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,sBAAsB;IACtB,OAAO,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB,CAAC,iBAAiB,CAAC;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,0BAA0B;IAC1B,OAAO,EAAE,WAAW,CAAC;IACrB,+BAA+B;IAC/B,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB,CAAC,iBAAiB,CAAC;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wCAAwC;IACxC,cAAc,EAAE,WAAW,CAAC;IAC5B,4CAA4C;IAC5C,gBAAgB,EAAE,WAAW,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,gBAAgB,CAAC,sBAAsB,CAAC;IAC/F,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,MAAM,EAAE,cAAc,CAAC;IACvB,yCAAyC;IACzC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB,CAAC,iBAAiB,CAAC;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAMD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,MAAM,EAAE,gBAAgB,CAAC;IACzB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAMD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,YAAY,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,kBAAkB,GAClB,0BAA0B,GAC1B,0BAA0B,GAC1B,+BAA+B,GAC/B,0BAA0B,CAAC;AAE/B,oCAAoC;AACpC,wBAAgB,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,mBAAmB,CAEhF;AAED,2CAA2C;AAC3C,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,sBAAsB,CAEzF;AAED,oCAAoC;AACpC,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,kBAAkB,CAE9E;AAED,4CAA4C;AAC5C,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,0BAA0B,CAE9F;AAED,4CAA4C;AAC5C,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,0BAA0B,CAE9F;AAED,iDAAiD;AACjD,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,+BAA+B,CAExG;AAED,4CAA4C;AAC5C,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,IAAI,0BAA0B,CAE9F"}