evolution-api-sdk/lib/modules/messages/schemas/poll.d.ts

Unofficial SDK for the Evolution Whatsapp API v2

import { Jid, MessageId } from '../../../types/tags.js';
import { BaseMessageOptions } from './base.js';

interface PollMessageResponseRaw {
    key: {
        remoteJid: string;
        id: string;
    };
    message: {
        pollCreationMessageV3: {
            name: string;
            options: {
                optionName: string;
            }[];
            selectableOptionsCount: number;
        };
    };
    messageTimestamp: string | Date;
}
interface PollMessageOptions extends BaseMessageOptions {
    /**
     * Name of the poll
     */
    name: string;
    /**
     * Whether multiple options can be selected
     * @default false
     */
    multiple?: boolean;
    /**
     * Poll options
     */
    options: string[];
}
interface PollMessageBody extends BaseMessageOptions {
    name: string;
    selectableCount: number;
    values: string[];
}
interface PollMessageResponse {
    receiver: {
        phoneNumber: string;
        jid: Jid;
    };
    poll: {
        name: string;
        options: string[];
        multiple: boolean;
    };
    id: MessageId;
    timestamp: Date;
}
declare const PollMessageBodyTransform: ({ multiple, options, ...data }: PollMessageOptions) => PollMessageBody;
declare const PollMessageResponseTransform: (data: PollMessageResponseRaw) => PollMessageResponse;
declare const BodySchema: {
    parse: ({ multiple, options, ...data }: PollMessageOptions) => PollMessageBody;
};
declare const ResponseSchema: {
    parse: (data: PollMessageResponseRaw) => PollMessageResponse;
};

export { BodySchema, type PollMessageBody, PollMessageBodyTransform, type PollMessageOptions, type PollMessageResponse, type PollMessageResponseRaw, PollMessageResponseTransform, ResponseSchema };