@open-apime/sdk 0.4.1 → 0.6.0

package/dist/events-BUqVWlyS.d.cts

@@ -0,0 +1,179 @@
+/**
+ * The 12 event types the apime delivers. `ignore` is internal and never
+ * reaches a consumer, so it is not part of the union.
+ */
+type WebhookEventType = "message" | "receipt" | "presence" | "chat_presence" | "reaction" | "contact_update" | "connected" | "disconnected" | "temporary_ban" | "restriction_lifted" | "contact_reachout_locked" | "unknown";
+interface WebhookEnvelope<T extends WebhookEventType = WebhookEventType, P = unknown> {
+    id: string;
+    instanceId: string;
+    type: T;
+    payload: P;
+    createdAt: string;
+}
+/** Button of an interactive message. `call`, `copy`, `reply` and `url` are button kinds, not events. */
+interface MessageButton {
+    id: string;
+    label: string;
+    type: "reply" | "url" | "copy" | "call";
+    url?: string;
+    code?: string;
+    phone?: string;
+}
+/** Row of a list section. */
+interface MessageListRow {
+    id: string;
+    label: string;
+    description: string;
+}
+/** Section of a list message. */
+interface MessageListSection {
+    title: string;
+    rows: MessageListRow[];
+}
+/**
+ * Interactive content of a received message. `kind` says how to render it:
+ * `buttons` carries `buttons`, `list` carries `sections`.
+ */
+interface MessageInteractive {
+    kind: "buttons" | "list";
+    text?: string;
+    footer?: string;
+    buttons?: MessageButton[];
+    sections?: MessageListSection[];
+}
+/**
+ * What the contact picked when tapping a button or list row. `selectedId` and
+ * `selectedLabel` are the useful pair; `name` and `paramsJson` are the raw
+ * NativeFlow fields, kept for anything the normalizer did not extract.
+ */
+interface MessageInteractiveReply {
+    selectedId?: string;
+    selectedLabel?: string;
+    name?: string;
+    paramsJson?: string;
+}
+interface MessagePayload {
+    from: string;
+    to: string;
+    /** Chat the message belongs to. Equals `to`, resolved to a phone number when possible. */
+    chatJID?: string;
+    /**
+     * Stable identity of the contact, emitted whenever known, even when the phone
+     * number was resolved. Use it to unify a contact instead of relying on the
+     * number, which changes.
+     */
+    lid?: string;
+    /** How the chat is addressed by WhatsApp: by phone number or by LID. */
+    addressingMode?: string;
+    isFromMe: boolean;
+    isGroup: boolean;
+    messageId: string;
+    timestamp: number;
+    pushName?: string;
+    /** Group only: who sent it inside the group. Both carry the same value. */
+    participant?: string;
+    author?: string;
+    /** Business accounts only, from the verified name certificate. */
+    verifiedName?: string;
+    issuer?: string;
+    text?: string;
+    mentionedJids?: string[];
+    mediaType?: "image" | "video" | "audio" | "document" | "sticker" | "location" | "contact";
+    mediaUrl?: string;
+    mimetype?: string;
+    caption?: string;
+    fileName?: string;
+    /** Size in bytes. */
+    fileSize?: number;
+    /** Audio and video: length in seconds. */
+    duration?: number;
+    /** Audio recorded as a voice note rather than an attached file. */
+    ptt?: boolean;
+    /** Video sent as a round "video note". */
+    isPtv?: boolean;
+    /** Location messages. */
+    latitude?: number;
+    longitude?: number;
+    address?: string;
+    /** Contact messages. `contactNumber` is the raw vCard, not a bare number. */
+    contactName?: string;
+    contactNumber?: string;
+    buttons?: MessageButton[];
+    /** Present when the message itself carries buttons or a list. */
+    interactive?: MessageInteractive;
+    /** Present when the message IS the contact's answer to a button or list. */
+    interactiveReply?: MessageInteractiveReply;
+    /**
+     * Present only when this event is an edit: the id of the message that was
+     * edited, and its new text. They always travel together, so checking one is
+     * enough to know it is an edit.
+     */
+    editedMessageId?: string;
+    editedText?: string;
+}
+/**
+ * A reaction added to, or removed from, a message. An empty `reactionEmoji`
+ * means the contact removed their reaction.
+ */
+interface ReactionPayload {
+    from: string;
+    chatJID: string;
+    isFromMe: boolean;
+    isGroup: boolean;
+    timestamp: number;
+    pushName?: string;
+    /** Group only: who reacted. Both carry the same value. */
+    participant?: string;
+    author?: string;
+    /** The emoji, or an empty string when the reaction was removed. */
+    reactionEmoji: string;
+    /** Id of the message that was reacted to. */
+    reactionMessageId?: string;
+}
+interface ReceiptPayload {
+    messageIds: string[];
+    timestamp: number;
+    chat: string;
+    status: "read" | "delivered" | "played";
+}
+interface PresencePayload {
+    from: string;
+    unavailable: boolean;
+    lastSeen?: number;
+}
+interface ChatPresencePayload {
+    from: string;
+    chatJID: string;
+    state: "composing" | "paused";
+    media?: "audio";
+}
+interface ContactUpdatePayload {
+    jid: string;
+    username: string;
+}
+interface DisconnectedPayload {
+    reason?: string;
+}
+/** Same shape for the account ban and for the reach-out timelock. */
+interface TemporaryBanPayload {
+    reason?: string;
+    code?: number;
+    active: boolean;
+    restrictedUntil?: string;
+    enforcementType?: string;
+}
+interface RestrictionLiftedPayload {
+    active: false;
+    enforcementType?: string;
+    restrictedUntil?: string;
+}
+interface ContactReachoutLockedPayload {
+    to: string;
+    reason: string;
+    detail: string;
+    code: number;
+}
+/** Discriminated by `type`, so a switch narrows the payload. */
+type WebhookEvent = WebhookEnvelope<"message", MessagePayload> | WebhookEnvelope<"receipt", ReceiptPayload> | WebhookEnvelope<"presence", PresencePayload> | WebhookEnvelope<"chat_presence", ChatPresencePayload> | WebhookEnvelope<"reaction", ReactionPayload> | WebhookEnvelope<"contact_update", ContactUpdatePayload> | WebhookEnvelope<"connected", Record<string, unknown>> | WebhookEnvelope<"disconnected", DisconnectedPayload> | WebhookEnvelope<"temporary_ban", TemporaryBanPayload> | WebhookEnvelope<"restriction_lifted", RestrictionLiftedPayload> | WebhookEnvelope<"contact_reachout_locked", ContactReachoutLockedPayload> | WebhookEnvelope<"unknown", Record<string, unknown>>;
+
+export type { ChatPresencePayload as C, DisconnectedPayload as D, MessageButton as M, PresencePayload as P, ReactionPayload as R, TemporaryBanPayload as T, WebhookEnvelope as W, ContactReachoutLockedPayload as a, ContactUpdatePayload as b, MessageInteractive as c, MessageInteractiveReply as d, MessageListRow as e, MessageListSection as f, MessagePayload as g, ReceiptPayload as h, RestrictionLiftedPayload as i, WebhookEvent as j, WebhookEventType as k };

package/dist/events-BUqVWlyS.d.ts

@@ -0,0 +1,179 @@
+/**
+ * The 12 event types the apime delivers. `ignore` is internal and never
+ * reaches a consumer, so it is not part of the union.
+ */
+type WebhookEventType = "message" | "receipt" | "presence" | "chat_presence" | "reaction" | "contact_update" | "connected" | "disconnected" | "temporary_ban" | "restriction_lifted" | "contact_reachout_locked" | "unknown";
+interface WebhookEnvelope<T extends WebhookEventType = WebhookEventType, P = unknown> {
+    id: string;
+    instanceId: string;
+    type: T;
+    payload: P;
+    createdAt: string;
+}
+/** Button of an interactive message. `call`, `copy`, `reply` and `url` are button kinds, not events. */
+interface MessageButton {
+    id: string;
+    label: string;
+    type: "reply" | "url" | "copy" | "call";
+    url?: string;
+    code?: string;
+    phone?: string;
+}
+/** Row of a list section. */
+interface MessageListRow {
+    id: string;
+    label: string;
+    description: string;
+}
+/** Section of a list message. */
+interface MessageListSection {
+    title: string;
+    rows: MessageListRow[];
+}
+/**
+ * Interactive content of a received message. `kind` says how to render it:
+ * `buttons` carries `buttons`, `list` carries `sections`.
+ */
+interface MessageInteractive {
+    kind: "buttons" | "list";
+    text?: string;
+    footer?: string;
+    buttons?: MessageButton[];
+    sections?: MessageListSection[];
+}
+/**
+ * What the contact picked when tapping a button or list row. `selectedId` and
+ * `selectedLabel` are the useful pair; `name` and `paramsJson` are the raw
+ * NativeFlow fields, kept for anything the normalizer did not extract.
+ */
+interface MessageInteractiveReply {
+    selectedId?: string;
+    selectedLabel?: string;
+    name?: string;
+    paramsJson?: string;
+}
+interface MessagePayload {
+    from: string;
+    to: string;
+    /** Chat the message belongs to. Equals `to`, resolved to a phone number when possible. */
+    chatJID?: string;
+    /**
+     * Stable identity of the contact, emitted whenever known, even when the phone
+     * number was resolved. Use it to unify a contact instead of relying on the
+     * number, which changes.
+     */
+    lid?: string;
+    /** How the chat is addressed by WhatsApp: by phone number or by LID. */
+    addressingMode?: string;
+    isFromMe: boolean;
+    isGroup: boolean;
+    messageId: string;
+    timestamp: number;
+    pushName?: string;
+    /** Group only: who sent it inside the group. Both carry the same value. */
+    participant?: string;
+    author?: string;
+    /** Business accounts only, from the verified name certificate. */
+    verifiedName?: string;
+    issuer?: string;
+    text?: string;
+    mentionedJids?: string[];
+    mediaType?: "image" | "video" | "audio" | "document" | "sticker" | "location" | "contact";
+    mediaUrl?: string;
+    mimetype?: string;
+    caption?: string;
+    fileName?: string;
+    /** Size in bytes. */
+    fileSize?: number;
+    /** Audio and video: length in seconds. */
+    duration?: number;
+    /** Audio recorded as a voice note rather than an attached file. */
+    ptt?: boolean;
+    /** Video sent as a round "video note". */
+    isPtv?: boolean;
+    /** Location messages. */
+    latitude?: number;
+    longitude?: number;
+    address?: string;
+    /** Contact messages. `contactNumber` is the raw vCard, not a bare number. */
+    contactName?: string;
+    contactNumber?: string;
+    buttons?: MessageButton[];
+    /** Present when the message itself carries buttons or a list. */
+    interactive?: MessageInteractive;
+    /** Present when the message IS the contact's answer to a button or list. */
+    interactiveReply?: MessageInteractiveReply;
+    /**
+     * Present only when this event is an edit: the id of the message that was
+     * edited, and its new text. They always travel together, so checking one is
+     * enough to know it is an edit.
+     */
+    editedMessageId?: string;
+    editedText?: string;
+}
+/**
+ * A reaction added to, or removed from, a message. An empty `reactionEmoji`
+ * means the contact removed their reaction.
+ */
+interface ReactionPayload {
+    from: string;
+    chatJID: string;
+    isFromMe: boolean;
+    isGroup: boolean;
+    timestamp: number;
+    pushName?: string;
+    /** Group only: who reacted. Both carry the same value. */
+    participant?: string;
+    author?: string;
+    /** The emoji, or an empty string when the reaction was removed. */
+    reactionEmoji: string;
+    /** Id of the message that was reacted to. */
+    reactionMessageId?: string;
+}
+interface ReceiptPayload {
+    messageIds: string[];
+    timestamp: number;
+    chat: string;
+    status: "read" | "delivered" | "played";
+}
+interface PresencePayload {
+    from: string;
+    unavailable: boolean;
+    lastSeen?: number;
+}
+interface ChatPresencePayload {
+    from: string;
+    chatJID: string;
+    state: "composing" | "paused";
+    media?: "audio";
+}
+interface ContactUpdatePayload {
+    jid: string;
+    username: string;
+}
+interface DisconnectedPayload {
+    reason?: string;
+}
+/** Same shape for the account ban and for the reach-out timelock. */
+interface TemporaryBanPayload {
+    reason?: string;
+    code?: number;
+    active: boolean;
+    restrictedUntil?: string;
+    enforcementType?: string;
+}
+interface RestrictionLiftedPayload {
+    active: false;
+    enforcementType?: string;
+    restrictedUntil?: string;
+}
+interface ContactReachoutLockedPayload {
+    to: string;
+    reason: string;
+    detail: string;
+    code: number;
+}
+/** Discriminated by `type`, so a switch narrows the payload. */
+type WebhookEvent = WebhookEnvelope<"message", MessagePayload> | WebhookEnvelope<"receipt", ReceiptPayload> | WebhookEnvelope<"presence", PresencePayload> | WebhookEnvelope<"chat_presence", ChatPresencePayload> | WebhookEnvelope<"reaction", ReactionPayload> | WebhookEnvelope<"contact_update", ContactUpdatePayload> | WebhookEnvelope<"connected", Record<string, unknown>> | WebhookEnvelope<"disconnected", DisconnectedPayload> | WebhookEnvelope<"temporary_ban", TemporaryBanPayload> | WebhookEnvelope<"restriction_lifted", RestrictionLiftedPayload> | WebhookEnvelope<"contact_reachout_locked", ContactReachoutLockedPayload> | WebhookEnvelope<"unknown", Record<string, unknown>>;
+
+export type { ChatPresencePayload as C, DisconnectedPayload as D, MessageButton as M, PresencePayload as P, ReactionPayload as R, TemporaryBanPayload as T, WebhookEnvelope as W, ContactReachoutLockedPayload as a, ContactUpdatePayload as b, MessageInteractive as c, MessageInteractiveReply as d, MessageListRow as e, MessageListSection as f, MessagePayload as g, ReceiptPayload as h, RestrictionLiftedPayload as i, WebhookEvent as j, WebhookEventType as k };

package/dist/{index-37ITjlwO.d.cts → index-CJP98yfj.d.cts}

@@ -1,4 +1,4 @@
-import { e as WebhookEvent } from './events-BV5UVoFu.cjs';
+import { j as WebhookEvent } from './events-BUqVWlyS.cjs';
 
 /**
  * One class per condition, so callers branch on the error instead of parsing

package/dist/{index-TqYrYke0.d.ts → index-CauhD-7n.d.ts}

@@ -1,4 +1,4 @@
-import { e as WebhookEvent } from './events-BV5UVoFu.js';
+import { j as WebhookEvent } from './events-BUqVWlyS.js';
 
 /**
  * One class per condition, so callers branch on the error instead of parsing

package/dist/index.cjs

@@ -490,6 +490,18 @@ var MessagesResource = class {
     form.set("file", input.file, input.filename ?? fileName(input.file, "media"));
     return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
   }
+  sendGif(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "gif");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "animation.mp4"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
+  sendSticker(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "sticker");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "sticker.webp"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
   sendAudio(input, options) {
     const form = toForm(input, ["file", "filename"]);
     form.set("file", input.file, input.filename ?? fileName(input.file, "audio.ogg"));

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-import { A as ApimeError } from './index-37ITjlwO.cjs';
-export { a as ApiError, b as AuthenticationError, C as ConfigurationError, c as ConflictError, d as ConnectionError, I as InvalidRequestError, e as InvalidSignatureError, N as NotFoundError, P as PermissionError, R as RateLimitError, S as SessionUnavailableError, T as TimeoutError, U as UnprocessableError, f as constructEvent, v as verifyWebhookSignature } from './index-37ITjlwO.cjs';
+import { A as ApimeError } from './index-CJP98yfj.cjs';
+export { a as ApiError, b as AuthenticationError, C as ConfigurationError, c as ConflictError, d as ConnectionError, I as InvalidRequestError, e as InvalidSignatureError, N as NotFoundError, P as PermissionError, R as RateLimitError, S as SessionUnavailableError, T as TimeoutError, U as UnprocessableError, f as constructEvent, v as verifyWebhookSignature } from './index-CJP98yfj.cjs';
 import { Instance, QrCode, EventLogEntry, InstanceInfo, Profile, SentMessage } from './types/index.cjs';
-export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessagePayload, P as PresencePayload, R as ReceiptPayload, d as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, e as WebhookEvent, f as WebhookEventType } from './events-BV5UVoFu.cjs';
+export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessageInteractive, d as MessageInteractiveReply, e as MessageListRow, f as MessageListSection, g as MessagePayload, P as PresencePayload, R as ReactionPayload, h as ReceiptPayload, i as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, j as WebhookEvent, k as WebhookEventType } from './events-BUqVWlyS.cjs';
 
 /**
  * The apime has three credentials and they do not overlap: 46 routes only
@@ -230,6 +230,32 @@ interface SendMediaInput extends QuoteInput, MarkReadInput {
     filename?: string;
     caption?: string;
 }
+/**
+ * A GIF on WhatsApp is an MP4 VIDEO carrying the gif-playback flag, which is what makes the client
+ * loop it with no controls. Sending a real `.gif` file arrives as a still image, so it gets a method
+ * of its own rather than a `type` on sendMedia: the name is what warns the caller at the call site.
+ */
+interface SendGifInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** MP4 bytes. A `.gif` file is NOT what WhatsApp expects here. */
+    file: Blob | File;
+    filename?: string;
+    caption?: string;
+}
+/**
+ * WhatsApp takes stickers as WebP 512x512, up to 500 KB, transparent background; animated ones are
+ * animated WebP. The server validates and refuses outside that, because a sticker off-spec is
+ * accepted by the wire and then fails to render, with nothing reporting it.
+ *
+ * There is no caption: the protocol has no such field on a sticker, so one would be dropped in
+ * silence. That is why this does not reuse `SendMediaInput`.
+ */
+interface SendStickerInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** WebP bytes, 512x512, up to 500 KB. */
+    file: Blob | File;
+    filename?: string;
+}
 interface SendAudioInput extends QuoteInput, MarkReadInput {
     to: string;
     file: Blob | File;
@@ -275,6 +301,8 @@ declare class MessagesResource {
     private get base();
     sendText(input: SendTextInput, options?: RequestOptions): Promise<SentMessage>;
     sendMedia(input: SendMediaInput, options?: RequestOptions): Promise<SentMessage>;
+    sendGif(input: SendGifInput, options?: RequestOptions): Promise<SentMessage>;
+    sendSticker(input: SendStickerInput, options?: RequestOptions): Promise<SentMessage>;
     sendAudio(input: SendAudioInput, options?: RequestOptions): Promise<SentMessage>;
     sendDocument(input: SendDocumentInput, options?: RequestOptions): Promise<SentMessage>;
     sendContact(input: SendContactInput, options?: RequestOptions): Promise<SentMessage>;
@@ -535,4 +563,4 @@ interface HealthResult {
 declare const DEFAULT_HEALTH_TIMEOUT_MS = 10000;
 declare function checkHealth(baseUrl: string, options?: HealthOptions): Promise<HealthResult>;
 
-export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, DEFAULT_HEALTH_TIMEOUT_MS, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, type HealthOptions, type HealthResult, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendLocationInput, type SendMediaInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };
+export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, DEFAULT_HEALTH_TIMEOUT_MS, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, type HealthOptions, type HealthResult, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendGifInput, type SendLocationInput, type SendMediaInput, type SendStickerInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { A as ApimeError } from './index-TqYrYke0.js';
-export { a as ApiError, b as AuthenticationError, C as ConfigurationError, c as ConflictError, d as ConnectionError, I as InvalidRequestError, e as InvalidSignatureError, N as NotFoundError, P as PermissionError, R as RateLimitError, S as SessionUnavailableError, T as TimeoutError, U as UnprocessableError, f as constructEvent, v as verifyWebhookSignature } from './index-TqYrYke0.js';
+import { A as ApimeError } from './index-CauhD-7n.js';
+export { a as ApiError, b as AuthenticationError, C as ConfigurationError, c as ConflictError, d as ConnectionError, I as InvalidRequestError, e as InvalidSignatureError, N as NotFoundError, P as PermissionError, R as RateLimitError, S as SessionUnavailableError, T as TimeoutError, U as UnprocessableError, f as constructEvent, v as verifyWebhookSignature } from './index-CauhD-7n.js';
 import { Instance, QrCode, EventLogEntry, InstanceInfo, Profile, SentMessage } from './types/index.js';
-export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessagePayload, P as PresencePayload, R as ReceiptPayload, d as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, e as WebhookEvent, f as WebhookEventType } from './events-BV5UVoFu.js';
+export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessageInteractive, d as MessageInteractiveReply, e as MessageListRow, f as MessageListSection, g as MessagePayload, P as PresencePayload, R as ReactionPayload, h as ReceiptPayload, i as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, j as WebhookEvent, k as WebhookEventType } from './events-BUqVWlyS.js';
 
 /**
  * The apime has three credentials and they do not overlap: 46 routes only
@@ -230,6 +230,32 @@ interface SendMediaInput extends QuoteInput, MarkReadInput {
     filename?: string;
     caption?: string;
 }
+/**
+ * A GIF on WhatsApp is an MP4 VIDEO carrying the gif-playback flag, which is what makes the client
+ * loop it with no controls. Sending a real `.gif` file arrives as a still image, so it gets a method
+ * of its own rather than a `type` on sendMedia: the name is what warns the caller at the call site.
+ */
+interface SendGifInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** MP4 bytes. A `.gif` file is NOT what WhatsApp expects here. */
+    file: Blob | File;
+    filename?: string;
+    caption?: string;
+}
+/**
+ * WhatsApp takes stickers as WebP 512x512, up to 500 KB, transparent background; animated ones are
+ * animated WebP. The server validates and refuses outside that, because a sticker off-spec is
+ * accepted by the wire and then fails to render, with nothing reporting it.
+ *
+ * There is no caption: the protocol has no such field on a sticker, so one would be dropped in
+ * silence. That is why this does not reuse `SendMediaInput`.
+ */
+interface SendStickerInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** WebP bytes, 512x512, up to 500 KB. */
+    file: Blob | File;
+    filename?: string;
+}
 interface SendAudioInput extends QuoteInput, MarkReadInput {
     to: string;
     file: Blob | File;
@@ -275,6 +301,8 @@ declare class MessagesResource {
     private get base();
     sendText(input: SendTextInput, options?: RequestOptions): Promise<SentMessage>;
     sendMedia(input: SendMediaInput, options?: RequestOptions): Promise<SentMessage>;
+    sendGif(input: SendGifInput, options?: RequestOptions): Promise<SentMessage>;
+    sendSticker(input: SendStickerInput, options?: RequestOptions): Promise<SentMessage>;
     sendAudio(input: SendAudioInput, options?: RequestOptions): Promise<SentMessage>;
     sendDocument(input: SendDocumentInput, options?: RequestOptions): Promise<SentMessage>;
     sendContact(input: SendContactInput, options?: RequestOptions): Promise<SentMessage>;
@@ -535,4 +563,4 @@ interface HealthResult {
 declare const DEFAULT_HEALTH_TIMEOUT_MS = 10000;
 declare function checkHealth(baseUrl: string, options?: HealthOptions): Promise<HealthResult>;
 
-export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, DEFAULT_HEALTH_TIMEOUT_MS, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, type HealthOptions, type HealthResult, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendLocationInput, type SendMediaInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };
+export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, DEFAULT_HEALTH_TIMEOUT_MS, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, type HealthOptions, type HealthResult, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendGifInput, type SendLocationInput, type SendMediaInput, type SendStickerInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };

package/dist/index.js

@@ -419,6 +419,18 @@ var MessagesResource = class {
     form.set("file", input.file, input.filename ?? fileName(input.file, "media"));
     return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
   }
+  sendGif(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "gif");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "animation.mp4"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
+  sendSticker(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "sticker");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "sticker.webp"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
   sendAudio(input, options) {
     const form = toForm(input, ["file", "filename"]);
     form.set("file", input.file, input.filename ?? fileName(input.file, "audio.ogg"));

package/dist/types/index.d.cts

@@ -1,4 +1,4 @@
-export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessagePayload, P as PresencePayload, R as ReceiptPayload, d as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, e as WebhookEvent, f as WebhookEventType } from '../events-BV5UVoFu.cjs';
+export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessageInteractive, d as MessageInteractiveReply, e as MessageListRow, f as MessageListSection, g as MessagePayload, P as PresencePayload, R as ReactionPayload, h as ReceiptPayload, i as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, j as WebhookEvent, k as WebhookEventType } from '../events-BUqVWlyS.cjs';
 
 /** Shapes the apime returns. Field names are the ones on the wire. */
 interface Instance {

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessagePayload, P as PresencePayload, R as ReceiptPayload, d as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, e as WebhookEvent, f as WebhookEventType } from '../events-BV5UVoFu.js';
+export { C as ChatPresencePayload, a as ContactReachoutLockedPayload, b as ContactUpdatePayload, D as DisconnectedPayload, M as MessageButton, c as MessageInteractive, d as MessageInteractiveReply, e as MessageListRow, f as MessageListSection, g as MessagePayload, P as PresencePayload, R as ReactionPayload, h as ReceiptPayload, i as RestrictionLiftedPayload, T as TemporaryBanPayload, W as WebhookEnvelope, j as WebhookEvent, k as WebhookEventType } from '../events-BUqVWlyS.js';
 
 /** Shapes the apime returns. Field names are the ones on the wire. */
 interface Instance {

package/dist/webhook/index.d.cts

@@ -1,2 +1,2 @@
-export { e as InvalidSignatureError, g as SIGNATURE_HEADER, f as constructEvent, v as verifyWebhookSignature } from '../index-37ITjlwO.cjs';
-export { e as WebhookEvent } from '../events-BV5UVoFu.cjs';
+export { e as InvalidSignatureError, g as SIGNATURE_HEADER, f as constructEvent, v as verifyWebhookSignature } from '../index-CJP98yfj.cjs';
+export { j as WebhookEvent } from '../events-BUqVWlyS.cjs';

package/dist/webhook/index.d.ts

@@ -1,2 +1,2 @@
-export { e as InvalidSignatureError, g as SIGNATURE_HEADER, f as constructEvent, v as verifyWebhookSignature } from '../index-TqYrYke0.js';
-export { e as WebhookEvent } from '../events-BV5UVoFu.js';
+export { e as InvalidSignatureError, g as SIGNATURE_HEADER, f as constructEvent, v as verifyWebhookSignature } from '../index-CauhD-7n.js';
+export { j as WebhookEvent } from '../events-BUqVWlyS.js';

package/docs/guia.md

@@ -48,6 +48,20 @@ await conexao.messages.sendMedia(
   { idempotencyKey: mensagem.id },
 );
 
+// GIF é MP4 com reprodução em laço, não arquivo .gif: mandar um .gif de verdade
+// faz a mensagem chegar como imagem parada.
+await conexao.messages.sendGif(
+  { to: "5511999999999", file: mp4Blob },
+  { idempotencyKey: mensagem.id },
+);
+
+// Figurinha exige WebP 512x512 até 500 KB (animada ou não), e não tem legenda:
+// o protocolo não traz esse campo. Fora da especificação, o apime recusa com 400.
+await conexao.messages.sendSticker(
+  { to: "5511999999999", file: webpBlob },
+  { idempotencyKey: mensagem.id },
+);
+
 await conexao.whatsapp.groups.updateParticipants(grupoJid, {
   action: "add",
   participants: ["5511999999999@s.whatsapp.net"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-apime/sdk",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Cliente TypeScript da API do apime: WhatsApp, instâncias e webhooks",
   "license": "MIT",
   "keywords": [

package/dist/events-BV5UVoFu.d.cts

@@ -1,90 +0,0 @@
-/**
- * The 12 event types the apime delivers. `ignore` is internal and never
- * reaches a consumer, so it is not part of the union.
- */
-type WebhookEventType = "message" | "receipt" | "presence" | "chat_presence" | "reaction" | "contact_update" | "connected" | "disconnected" | "temporary_ban" | "restriction_lifted" | "contact_reachout_locked" | "unknown";
-interface WebhookEnvelope<T extends WebhookEventType = WebhookEventType, P = unknown> {
-    id: string;
-    instanceId: string;
-    type: T;
-    payload: P;
-    createdAt: string;
-}
-/** Button of an interactive message. `call`, `copy`, `reply` and `url` are button kinds, not events. */
-interface MessageButton {
-    id: string;
-    label: string;
-    type: "reply" | "url" | "copy" | "call";
-    url?: string;
-    code?: string;
-    phone?: string;
-}
-interface MessagePayload {
-    from: string;
-    to: string;
-    isFromMe: boolean;
-    isGroup: boolean;
-    messageId: string;
-    timestamp: number;
-    pushName?: string;
-    text?: string;
-    mediaType?: "image" | "video" | "audio" | "document" | "sticker" | "location" | "contact";
-    mediaUrl?: string;
-    mimetype?: string;
-    caption?: string;
-    buttons?: MessageButton[];
-    /**
-     * Present only when this event is an edit: the id of the message that was
-     * edited, and its new text. They always travel together, so checking one is
-     * enough to know it is an edit.
-     */
-    editedMessageId?: string;
-    editedText?: string;
-}
-interface ReceiptPayload {
-    messageIds: string[];
-    timestamp: number;
-    chat: string;
-    status: "read" | "delivered" | "played";
-}
-interface PresencePayload {
-    from: string;
-    unavailable: boolean;
-    lastSeen?: number;
-}
-interface ChatPresencePayload {
-    from: string;
-    chatJID: string;
-    state: "composing" | "paused";
-    media?: "audio";
-}
-interface ContactUpdatePayload {
-    jid: string;
-    username: string;
-}
-interface DisconnectedPayload {
-    reason?: string;
-}
-/** Same shape for the account ban and for the reach-out timelock. */
-interface TemporaryBanPayload {
-    reason?: string;
-    code?: number;
-    active: boolean;
-    restrictedUntil?: string;
-    enforcementType?: string;
-}
-interface RestrictionLiftedPayload {
-    active: false;
-    enforcementType?: string;
-    restrictedUntil?: string;
-}
-interface ContactReachoutLockedPayload {
-    to: string;
-    reason: string;
-    detail: string;
-    code: number;
-}
-/** Discriminated by `type`, so a switch narrows the payload. */
-type WebhookEvent = WebhookEnvelope<"message", MessagePayload> | WebhookEnvelope<"receipt", ReceiptPayload> | WebhookEnvelope<"presence", PresencePayload> | WebhookEnvelope<"chat_presence", ChatPresencePayload> | WebhookEnvelope<"reaction", Record<string, unknown>> | WebhookEnvelope<"contact_update", ContactUpdatePayload> | WebhookEnvelope<"connected", Record<string, unknown>> | WebhookEnvelope<"disconnected", DisconnectedPayload> | WebhookEnvelope<"temporary_ban", TemporaryBanPayload> | WebhookEnvelope<"restriction_lifted", RestrictionLiftedPayload> | WebhookEnvelope<"contact_reachout_locked", ContactReachoutLockedPayload> | WebhookEnvelope<"unknown", Record<string, unknown>>;
-
-export type { ChatPresencePayload as C, DisconnectedPayload as D, MessageButton as M, PresencePayload as P, ReceiptPayload as R, TemporaryBanPayload as T, WebhookEnvelope as W, ContactReachoutLockedPayload as a, ContactUpdatePayload as b, MessagePayload as c, RestrictionLiftedPayload as d, WebhookEvent as e, WebhookEventType as f };

package/dist/events-BV5UVoFu.d.ts

@@ -1,90 +0,0 @@
-/**
- * The 12 event types the apime delivers. `ignore` is internal and never
- * reaches a consumer, so it is not part of the union.
- */
-type WebhookEventType = "message" | "receipt" | "presence" | "chat_presence" | "reaction" | "contact_update" | "connected" | "disconnected" | "temporary_ban" | "restriction_lifted" | "contact_reachout_locked" | "unknown";
-interface WebhookEnvelope<T extends WebhookEventType = WebhookEventType, P = unknown> {
-    id: string;
-    instanceId: string;
-    type: T;
-    payload: P;
-    createdAt: string;
-}
-/** Button of an interactive message. `call`, `copy`, `reply` and `url` are button kinds, not events. */
-interface MessageButton {
-    id: string;
-    label: string;
-    type: "reply" | "url" | "copy" | "call";
-    url?: string;
-    code?: string;
-    phone?: string;
-}
-interface MessagePayload {
-    from: string;
-    to: string;
-    isFromMe: boolean;
-    isGroup: boolean;
-    messageId: string;
-    timestamp: number;
-    pushName?: string;
-    text?: string;
-    mediaType?: "image" | "video" | "audio" | "document" | "sticker" | "location" | "contact";
-    mediaUrl?: string;
-    mimetype?: string;
-    caption?: string;
-    buttons?: MessageButton[];
-    /**
-     * Present only when this event is an edit: the id of the message that was
-     * edited, and its new text. They always travel together, so checking one is
-     * enough to know it is an edit.
-     */
-    editedMessageId?: string;
-    editedText?: string;
-}
-interface ReceiptPayload {
-    messageIds: string[];
-    timestamp: number;
-    chat: string;
-    status: "read" | "delivered" | "played";
-}
-interface PresencePayload {
-    from: string;
-    unavailable: boolean;
-    lastSeen?: number;
-}
-interface ChatPresencePayload {
-    from: string;
-    chatJID: string;
-    state: "composing" | "paused";
-    media?: "audio";
-}
-interface ContactUpdatePayload {
-    jid: string;
-    username: string;
-}
-interface DisconnectedPayload {
-    reason?: string;
-}
-/** Same shape for the account ban and for the reach-out timelock. */
-interface TemporaryBanPayload {
-    reason?: string;
-    code?: number;
-    active: boolean;
-    restrictedUntil?: string;
-    enforcementType?: string;
-}
-interface RestrictionLiftedPayload {
-    active: false;
-    enforcementType?: string;
-    restrictedUntil?: string;
-}
-interface ContactReachoutLockedPayload {
-    to: string;
-    reason: string;
-    detail: string;
-    code: number;
-}
-/** Discriminated by `type`, so a switch narrows the payload. */
-type WebhookEvent = WebhookEnvelope<"message", MessagePayload> | WebhookEnvelope<"receipt", ReceiptPayload> | WebhookEnvelope<"presence", PresencePayload> | WebhookEnvelope<"chat_presence", ChatPresencePayload> | WebhookEnvelope<"reaction", Record<string, unknown>> | WebhookEnvelope<"contact_update", ContactUpdatePayload> | WebhookEnvelope<"connected", Record<string, unknown>> | WebhookEnvelope<"disconnected", DisconnectedPayload> | WebhookEnvelope<"temporary_ban", TemporaryBanPayload> | WebhookEnvelope<"restriction_lifted", RestrictionLiftedPayload> | WebhookEnvelope<"contact_reachout_locked", ContactReachoutLockedPayload> | WebhookEnvelope<"unknown", Record<string, unknown>>;
-
-export type { ChatPresencePayload as C, DisconnectedPayload as D, MessageButton as M, PresencePayload as P, ReceiptPayload as R, TemporaryBanPayload as T, WebhookEnvelope as W, ContactReachoutLockedPayload as a, ContactUpdatePayload as b, MessagePayload as c, RestrictionLiftedPayload as d, WebhookEvent as e, WebhookEventType as f };