talkyzap-wapp-api 1.0.0

package/dist/chat/functions/prepareAudioWaveform.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { AudioMessageOptions } from './sendFileMessage';
+/**
+ * Prepare waveform form message audio file
+ *
+ * @category Message
+ * @internal
+ */
+export declare function prepareAudioWaveform(options: AudioMessageOptions, file: File): Promise<undefined | {
+    duration: number;
+    waveform: Uint8Array;
+}>;

package/dist/chat/functions/prepareLinkPreview.d.ts

@@ -0,0 +1,53 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { RawMessage } from '..';
+export interface LinkPreviewOptions {
+    /**
+     * Send text message with link preview
+     *
+     * @default true
+     *
+     * @example
+     * ```javascript
+     * // Automatic detection
+     * WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8');
+     *
+     * // Overriding the title and description
+     * WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8', {
+     *   linkPreview: {
+     *     title: 'Another text',
+     *     description: 'Another description'
+     *   }
+     * });
+     * ```
+     */
+    linkPreview?: boolean | {
+        title?: string;
+        description?: string;
+        canonicalUrl?: string;
+        matchedText?: string;
+        richPreviewType?: number;
+        thumbnail?: string;
+        doNotPlayInline: boolean;
+    };
+}
+/**
+ * Prepare a message for link preview
+ *
+ * @category Message
+ * @internal
+ */
+export declare function prepareLinkPreview<T extends RawMessage>(message: T, options: LinkPreviewOptions): Promise<T>;

package/dist/chat/functions/prepareMessageButtons.d.ts

@@ -0,0 +1,52 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { RawMessage } from '..';
+export type MessageButtonsTypes = {
+    id: string;
+    text: string;
+} | {
+    phoneNumber: string;
+    text: string;
+} | {
+    url: string;
+    text: string;
+};
+export interface MessageButtonsOptions {
+    /**
+     * List of buttons, with at least 1 option and a maximum of 3
+     */
+    buttons?: Array<MessageButtonsTypes>;
+    /**
+     * Title for buttons, only for text message
+     */
+    title?: string;
+    /**
+     * Set to use template buttons instead of reply buttons.
+     * @default: undefined - auto detect
+     */
+    useTemplateButtons?: boolean | null;
+    /**
+     * Footer text for buttons
+     */
+    footer?: string;
+}
+/**
+ * Prepare a message for buttons
+ *
+ * @category Message
+ * @internal
+ */
+export declare function prepareMessageButtons<T extends RawMessage>(message: T, options: MessageButtonsOptions): T;

package/dist/chat/functions/prepareRawMessage.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ChatModel } from '../../whatsapp';
+import { RawMessage, SendMessageOptions } from '..';
+/**
+ * Prepare a raw message
+ * @category Message
+ * @internal
+ */
+export declare function prepareRawMessage<T extends RawMessage>(chat: ChatModel, message: T, options?: SendMessageOptions): Promise<T>;

package/dist/chat/functions/requestPhoneNumber.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SendMessageOptions, SendMessageReturn } from '..';
+/**
+ * Request the real phone number for a LID chat ([number]@lid)
+ *
+ * @example
+ * ```javascript
+ * // Request
+ * WPP.chat.requestPhoneNumber('[number]@lid');
+ * ```
+ *
+ * @category Message
+ */
+export declare function requestPhoneNumber(chatId: any, options?: SendMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/functions/sendCreatePollMessage.d.ts

@@ -0,0 +1,49 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface PoolMessageOptions extends SendMessageOptions {
+    selectableCount?: number;
+}
+/**
+ * Send a create poll message
+ *
+ * Note: This only works for groups
+ *
+ * @example
+ * ```javascript
+ * // Single pool
+ * WPP.chat.sendCreatePollMessage(
+ *  '[number]@g.us',
+ *  'A poll name',
+ *  ['Option 1', 'Option 2', 'Option 3']
+ * );
+ * ```
+ * // Selectable Count
+ * ```javascript
+ * // Single pool
+ * WPP.chat.sendCreatePollMessage(
+ *  '[number]@g.us',
+ *  'A poll name',
+ *  ['Option 1', 'Option 2', 'Option 3'],
+ *  {
+ *    selectableCount: 1,
+ *  }
+ * );
+ * ```
+ *
+ * @category Message
+ */
+export declare function sendCreatePollMessage(chatId: any, name: string, choices: string[], options?: PoolMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/functions/sendFileMessage.d.ts

@@ -0,0 +1,181 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SendMessageOptions, SendMessageReturn } from '..';
+import { MessageButtonsOptions } from '.';
+export interface FileMessageOptions extends SendMessageOptions {
+    type?: string;
+    caption?: string;
+    footer?: string;
+    filename?: string;
+    mimetype?: string;
+}
+export interface AutoDetectMessageOptions extends FileMessageOptions {
+    type: 'auto-detect';
+}
+/**
+ * Send an audio message as a PTT, like a recorded message
+ *
+ * @example
+ * ```javascript
+ * // PTT audio
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:audio/mp3;base64,<a long base64 file...>',
+ *  {
+ *    type: 'audio',
+ *    isPtt: true // false for common audio
+ *  }
+ * );
+ * ```
+ */
+export interface AudioMessageOptions extends FileMessageOptions {
+    type: 'audio';
+    isPtt?: boolean;
+    /**
+     * Send an audio message as a PTT with waveform
+     *
+     * @example
+     * ```javascript
+     * // Enable waveform
+     * WPP.chat.sendFileMessage(
+     *  '[number]@c.us',
+     *  'data:audio/mp3;base64,<a long base64 file...>',
+     *  {
+     *    type: 'audio',
+     *    isPtt: true,
+     *    waveform: true // false to disable
+     *  }
+     * );
+     * // Disable waveform
+     * WPP.chat.sendFileMessage(
+     *  '[number]@c.us',
+     *  'data:audio/mp3;base64,<a long base64 file...>',
+     *  {
+     *    type: 'audio',
+     *    isPtt: true,
+     *    waveform: false
+     *  }
+     * );
+     * ```
+     */
+    waveform?: boolean;
+}
+export interface DocumentMessageOptions extends FileMessageOptions, MessageButtonsOptions {
+    type: 'document';
+}
+export interface ImageMessageOptions extends FileMessageOptions, MessageButtonsOptions {
+    type: 'image';
+    isViewOnce?: boolean;
+}
+export interface StickerMessageOptions extends FileMessageOptions {
+    type: 'sticker';
+}
+export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsOptions {
+    type: 'video';
+    isGif?: boolean;
+    isPtv?: boolean;
+}
+/**
+ * Send a file message, that can be an audio, document, image, sticker or video
+ *
+ * @example
+ * ```javascript
+ * // Single document
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:application/msword;base64,<a long base64 file...>',
+ *  {
+ *    type: 'document',
+ *    caption: 'My document', // Optional
+ *    filename: 'myfile.doc', // Optional
+ *    mimetype: 'application/msword' // Optional
+ *  }
+ * );
+ *
+ * // Image with view once
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:image/jpeg;base64,<a long base64 file...>',
+ *  {
+ *    type: 'image',
+ *    caption: 'My image', // Optional
+ *    isViewOnce: true
+ *  }
+ * );
+ *
+ * // PTT audio
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:audio/mp3;base64,<a long base64 file...>',
+ *  {
+ *    type: 'audio',
+ *    isPtt: true // false for common audio
+ *  }
+ * );
+ *
+ * // Image with view buttons
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:image/jpeg;base64,<a long base64 file...>',
+ *  {
+ *    type: 'image',
+ *    caption: 'My image'
+ *    buttons: [
+ *      {
+ *        id: 'your custom id 1',
+ *        text: 'Some text'
+ *      },
+ *      {
+ *        id: 'another id 2',
+ *        text: 'Another text'
+ *      }
+ *    ],
+ *    footer: 'Footer text' // Optional
+ *  }
+ * );
+ *
+ * // Image as Sticker
+ * WPP.chat.sendFileMessage(
+ *   '[number]@c.us',
+ *   'data:image/png;base64,<a long base64 file...>',
+ *   {
+ *     type: 'sticker'
+ *   }
+ * );
+ *
+ * // A simple video
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:application/msword;base64,<a long base64 file...>',
+ *  {
+ *    type: 'video',
+ *  }
+ * );
+ *
+ * // A PTV Video (micro video)
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'data:application/msword;base64,<a long base64 file...>',
+ *  {
+ *    type: 'video',
+ *    isPtv: true,
+ *  }
+ * );
+ * ```
+ * @category Message
+ * @return  {SendMessageReturn} The result
+ */
+export declare function sendFileMessage(chatId: any, content: string | Blob | File, options: AutoDetectMessageOptions | AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions | StickerMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/functions/sendGroupInviteMessage.d.ts

@@ -0,0 +1,56 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface GroupInviteMessage extends SendMessageOptions {
+    jpegThumbnail?: string;
+    inviteCode: string;
+    inviteCodeExpiration?: number;
+    groupId: string | Wid;
+    groupName?: string;
+    caption?: string;
+}
+/**
+ * Send a group invite message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendGroupInviteMessage(
+ *  '[number]@c.us',
+ *  {
+ *    inviteCode: '123',
+ *    groupId: '789@g.us'
+ *  }
+ * );
+ *
+ * // After a invite
+ * const result = await WPP.group.addParticipants('789@g.us', '123@c.us');
+ * const participant = result['123@c.us'];
+ * if (participant.invite_code) {
+ *   WPP.chat.sendGroupInviteMessage(
+ *     '123@c.us',
+ *     {
+ *       inviteCode: participant.invite_code,
+ *       inviteCodeExpiration: participant.invite_code_exp,
+ *       groupId: '789@g.us'
+ *     }
+ *   );
+ * }
+ * ```
+ *
+ * @category Message
+ */
+export declare function sendGroupInviteMessage(chatId: any, options: GroupInviteMessage): Promise<SendMessageReturn>;

package/dist/chat/functions/sendListMessage.d.ts

@@ -0,0 +1,57 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface ListMessageOptions extends SendMessageOptions {
+    buttonText: string;
+    description: string;
+    title?: string;
+    footer?: string;
+    sections: Array<{
+        title: string;
+        rows: Array<{
+            rowId: string;
+            title: string;
+            description: string;
+        }>;
+    }>;
+}
+/**
+ * Send a list message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendListMessage('[number]@c.us', {
+ *   buttonText: 'Click Me!', //required
+ *   description: "Hello it's list message", //required
+ *   title: 'Hello user', //optional
+ *   footer: 'Click and choose one', //optional
+ *   sections: [{
+ *     title: 'Section 1',
+ *     rows: [{
+ *       rowId: 'rowid1',
+ *       title: 'Row 1',
+ *       description: "Hello it's description 1",
+ *     },{
+ *       rowId: 'rowid2',
+ *       title: 'Row 2',
+ *       description: "Hello it's description 2",
+ *     }]
+ *   }]
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendListMessage(chatId: any, options: ListMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/functions/sendLocationMessage.d.ts

@@ -0,0 +1,100 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SendMessageOptions, SendMessageReturn } from '..';
+import { MessageButtonsOptions } from './prepareMessageButtons';
+export interface LocationMessageOptions extends SendMessageOptions, MessageButtonsOptions {
+    /**
+     * latitude in degrees
+     */
+    lat: number | string;
+    /**
+     * longitude in degrees
+     */
+    lng: number | string;
+    /**
+     * The full address of place
+     */
+    address?: string;
+    /**
+     * Name of the place
+     */
+    name?: string;
+    /**
+     * URL to open when click on the address/name
+     */
+    url?: string;
+}
+/**
+ * Send a location message
+ *
+ * @example
+ * ```javascript
+ * // full example
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ *  name: 'Cristo Rendentor', // optional
+ *  address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ', // optional
+ *  url: 'https://santuariocristoredentor.com.br/' // optional
+ * });
+ *
+ * // minimal
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ * });
+ *
+ * // name and address
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ *  name: 'Cristo Rendentor',
+ *  address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ'
+ * });
+ *
+ * // with buttons
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ *  name: 'Cristo Rendentor',
+ *  address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ',
+ *  buttons: [
+ *      {
+ *          url: 'https://example.test/',
+ *          text: 'URL example'
+ *      },
+ *      {
+ *          phoneNumber: '+55 12 3456 7777',
+ *          text: 'Phone Number'
+ *      },
+ *      {
+ *          id: 'id1',
+ *          text: 'First'
+ *      },
+ *      {
+ *          id: 'id2',
+ *          text: 'Second'
+ *      },
+ *      {
+ *          id: 'other',
+ *          text: 'Other'
+ *      }
+ *  ],
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendLocationMessage(chatId: any, options: LocationMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/functions/sendOrderMessage.d.ts

@@ -0,0 +1,57 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface OrderItems {
+    type: 'product' | 'custom';
+    id?: number[] | string[];
+    name?: string;
+    price?: number;
+    qnt?: number;
+}
+export interface OrderMessageOptions extends SendMessageOptions {
+    notes?: string;
+    discount?: number;
+    tax?: number;
+    shipping?: number;
+    offset?: number;
+}
+/**
+ * Send a order message
+ * To send (prices, tax, shipping or discount), for example: USD 12.90, send them without dots or commas, like: 12900
+ *
+ * @example
+ * ```javascript
+ * // Send Order with a product
+ * WPP.chat.sendOrderMessage('[number]@c.us', [
+ *   { type: 'product', id: '67689897878', qnt: 2 },
+ *   { type: 'product', id: '37878774457', qnt: 1 },
+ * ]
+ *
+ * // Send Order with a custom item
+ * WPP.chat.sendOrderMessage('[number]@c.us', [
+ *   { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
+ * ]
+ *
+ * // Send Order with custom options
+ * WPP.chat.sendOrderMessage('[number]@c.us', [
+ *   { type: 'product', id: '37878774457', qnt: 1 },
+ *   { type: 'custom', name: 'Item de cost test', price: 120000, qnt: 2 },
+ * ],
+ * { tax: 10000, shipping: 4000, discount: 10000 }
+ * ```
+ * @category Message
+ */
+export declare function sendOrderMessage(chatId: any, items: OrderItems[], options?: OrderMessageOptions): Promise<SendMessageReturn>;