import { AbstractMessage } from '../AbstractMessage.js'; import { Channels } from '../../enums/Channels.js'; import { MessageTypes } from '../../enums/MessageTypes.js'; import { WhatsAppContext } from '../../types/Channels/WhatsApp/WhatsAppParams.js'; import { WhatsAppStickerIdType } from '../../types/Channels/WhatsApp/WhatsAppStickerIdType.js'; import { WhatsAppStickerParams } from '../../types/Channels/WhatsApp/WhatsAppStickerParams.js'; import { WhatsAppStickerUrlType } from '../../types/Channels/WhatsApp/WhatsAppStickerUrlType.js'; import '../../types/MessageParams.js'; /** * Represents a sticker message for WhatsApp. * * @group WhatsApp */ declare class WhatsAppSticker extends AbstractMessage implements WhatsAppStickerParams { /** * The channel for this message (always 'whatsapp'). */ channel: Channels.WHATSAPP; /** * The type of message (always 'sticker'). */ messageType: MessageTypes.STICKER; sticker: WhatsAppStickerIdType | WhatsAppStickerUrlType; context?: WhatsAppContext; /** * Send via MM Lite API only this is valid for marketing template messages * only, and for Alpha release only * * @deprecated */ category?: string; /** * Send a sticker message to a WhatsApp user. * * @param {WhatsAppStickerParams} params - The parameters for creating a WhatsApp sticker message. * @example * Send a sticker message with a sticker ID: * ```ts * import { WhatsAppSticker } from '@vonage/messages'; * * const { messageUUID } = await messagesClient.send(new WhatsAppSticker({ * to: TO_NUMBER, * from: FROM_NUMBER, * sticker: { * id: '0-0', * }, * clientRef: 'my-personal-reference', * })); * * console.log(`Message sent successfully with UUID ${messageUUID}`); * ``` * * @example * Send a sticker message with a sticker URL: * ```ts * import { WhatsAppSticker } from '@vonage/messages'; * * const { messageUUID } = await messagesClient.send(new WhatsAppSticker({ * to: TO_NUMBER, * from: FROM_NUMBER, * sticker: { * url: 'https://example.com/sticker.png', * }, * clientRef: 'my-personal-reference', * })); * * console.log(`Message sent successfully with UUID ${messageUUID}`); * ``` */ constructor(params: Omit); } export { WhatsAppSticker };