talkyzap-wapp-api 1.0.0

package/dist/catalog/functions/getProductById.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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 { ProductModel } from '../../whatsapp';
+/**
+ * Retrieves product by id
+ *
+ * @example
+ * ```javascript
+ * // Retrieve data of product
+ * await WPP.catalog.getProductById('5521985565656@c.us', '68685985868923');
+ * ```
+ *
+ * @category Catalog
+ */
+export declare function getProductById(chatId: string, productId: number): Promise<ProductModel>;

package/dist/catalog/functions/getProducts.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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.
+ */
+/**
+ * Retrieves product by contact id
+ *
+ * @example
+ * Get products of catalogs
+ * ```javascript
+ * await WPP.catalog.getProducts('5521985625689@c.us', 10);
+ * ```
+ * @return A array with products
+ * @category Catalog
+ */
+export declare function getProducts(chatId: string, qnt: number): Promise<any[]>;

package/dist/catalog/functions/index.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * 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.
+ */
+export { addProductImage } from './addProductImage';
+export { changeProductImage } from './changeProductImage';
+export { createCollection } from './createCollection';
+export { createProduct } from './createProduct';
+export { deleteCollection } from './deleteCollection';
+export { delProducts } from './deleteProduct';
+export { editCollection } from './editCollection';
+export { editProduct } from './editProduct';
+export { getCollections } from './getCollections';
+export { getMyCatalog } from './getMyCatalog';
+export { getProductById } from './getProductById';
+export { getProducts } from './getProducts';
+export { removeProductImage } from './removeProductImage';
+export { setProductVisibility } from './setProductVisibility';
+export { updateCartEnabled } from './updateCartEnabled';

package/dist/catalog/functions/removeProductImage.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * 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 { ProductModel } from '../../whatsapp';
+/**
+ * Remove image on product
+ * This function remove additional images of product
+ * for change main image use @changeProductImage
+ *
+ * @example
+ * ```javascript
+ * await WPP.catalog.removeProductImage('68685985868923', '0');
+ * ```
+ * @param index - Index of array additionalImageCdnUrl
+ * @category Catalog
+ */
+export declare function removeProductImage(productId: string, index: string): Promise<ProductModel>;

package/dist/catalog/functions/setProductVisibility.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * 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.
+ */
+/**
+ * Get your current catalog
+ *
+ * @example
+ * ```javascript
+ * // Set product visibility hidden
+ * const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);
+ * ```
+ * // Set product visible
+ * const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, false);
+ * ```
+ *
+ * @return Return sucess of product visibility set
+ */
+export declare function setProductVisibility(productId: any, isHidden: boolean): Promise<any>;

package/dist/catalog/functions/updateCartEnabled.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * 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.
+ */
+/**
+ * Get your current catalog
+ *
+ * @example
+ * ```javascript
+ * // Set product visibility hidden
+ * const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);
+ * ```
+ * // Set product visible
+ * const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, false);
+ * ```
+ *
+ * @return Return sucess of product visibility set
+ */
+export declare function updateCartEnabled(enabled: boolean): Promise<any>;

package/dist/catalog/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export * from './functions';

package/dist/chat/defaultSendMessageOptions.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * 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 { LinkPreviewOptions, MessageButtonsOptions, SendMessageOptions } from '.';
+import { ListMessageOptions } from './functions/sendListMessage';
+export type AllMessageOptions = SendMessageOptions & LinkPreviewOptions & MessageButtonsOptions & Partial<ListMessageOptions>;
+export declare const defaultSendMessageOptions: AllMessageOptions;

package/dist/chat/events/eventTypes.d.ts

@@ -0,0 +1,183 @@
+/*!
+ * 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 { Label } from '../../labels';
+import { ChatModel, MsgKey, MsgModel, Wid } from '../../whatsapp';
+export interface ChatEventTypes {
+    /**
+     * Triggered when change the active chat
+     *
+     * @example
+     * ```javascript
+     * WPP.on('chat.active_chat', (chat) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'chat.active_chat': ChatModel;
+    /**
+     * Triggered when new message is received
+     *
+     * @example
+     * ```javascript
+     * WPP.on('chat.new_message', (msg) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'chat.new_message': MsgModel;
+    'chat.msg_revoke': {
+        /**
+         * Author of message, only for groups
+         */
+        author?: Wid;
+        from: Wid;
+        /**
+         * Message id of revoke event
+         */
+        id: MsgKey;
+        /**
+         * Message id of revoked message
+         */
+        refId: MsgKey;
+        to: Wid;
+        /**
+         * Type of revoke
+         */
+        type: 'revoke' | 'sender_revoke' | 'admin_revoke';
+    };
+    'chat.msg_ack_change': {
+        ack: number;
+        /**
+         * Who sended the ack, only for groups, broadcast and status
+         */
+        sender?: Wid;
+        /**
+         * The chat that sended the messeage
+         */
+        chat: Wid;
+        /**
+         * Message id of revoke event
+         */
+        ids: MsgKey[];
+    };
+    /**
+     * On Message edit
+     */
+    'chat.msg_edited': {
+        chat: Wid;
+        id: string;
+        msg: MsgModel;
+    };
+    'chat.live_location_start': {
+        id: Wid;
+        msgId: MsgKey;
+        chat: Wid;
+        lat: number;
+        lng: number;
+        accuracy?: number;
+        speed?: number;
+        degrees?: number;
+        shareDuration: number;
+    };
+    /**
+     * @deprecated Temporary unsuported by WhatsApp Web Multi-Device
+     */
+    'chat.live_location_update': {
+        id: Wid;
+        lastUpdated: number;
+        elapsed: number;
+        lat: number;
+        lng: number;
+        accuracy?: number;
+        speed?: number;
+        degrees?: number;
+        comment: string;
+    };
+    /**
+     * @deprecated Temporary unsuported by WhatsApp Web Multi-Device
+     */
+    'chat.live_location_end': {
+        id: Wid;
+        chat: Wid;
+        seq: number;
+    };
+    /**
+     * Triggered when a new reaction is received
+     *
+     * @example
+     * ```javascript
+     * WPP.on('chat.new_reaction', (msg) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'chat.new_reaction': {
+        /**
+         * Reaction ID
+         */
+        id: MsgKey;
+        /**
+         * Message ID that received the reaction
+         */
+        msgId: MsgKey;
+        /**
+         * The reaction emoji or empty if removed
+         */
+        reactionText: string;
+        read: boolean;
+        sender: Wid;
+        orphan: number;
+        orphanReason: any;
+        timestamp: number;
+    };
+    /**
+     * On presence change
+     */
+    'chat.presence_change': {
+        id: Wid;
+        isOnline: boolean;
+        isGroup: boolean;
+        isUser: boolean;
+        shortName: string;
+        state: string;
+        t: number;
+        isContact?: boolean;
+        participants?: {
+            id: string;
+            state: string;
+            shortName: string;
+        }[];
+    };
+    /**
+     * On Poll response
+     */
+    'chat.poll_response': {
+        msgId: MsgKey;
+        chatId: Wid;
+        selectedOptions: number[];
+        timestamp: number;
+        sender: Wid;
+    };
+    /**
+     * On Labels update
+     */
+    'chat.update_label': {
+        chat: ChatModel;
+        ids: string[];
+        labels: Label[];
+        type: 'add' | 'remove';
+    };
+}

package/dist/chat/events/index.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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 './registerAckMessageEvent';
+import './registerActiveChatEvent';
+import './registerLiveLocationUpdateEvent';
+import './registerNewMessageEvent';
+import './registerPollEvent';
+import './registerPresenceChange';
+import './registerReactionsEvent';
+import './registerRevokeMessageEvent';
+import './registerLabelEvent';
+import './registerEditedMessageEvent';

package/dist/chat/events/registerAckMessageEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerActiveChatEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerEditedMessageEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerLabelEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerLiveLocationUpdateEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerNewMessageEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerPollEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerPresenceChange.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerReactionsEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerRevokeMessageEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

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

@@ -0,0 +1,54 @@
+/*!
+ * 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';
+/**
+ * Archive a chat
+ *
+ * @example
+ * ```javascript
+ * // Archive a chat
+ * WPP.chat.archive('[number]@c.us');
+ *
+ * // Unarchive a chat
+ * WPP.chat.archive('[number]@c.us', false);
+ * // or
+ * WPP.chat.unarchive('[number]@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function archive(chatId: string | Wid, archive?: boolean): Promise<{
+    wid: Wid;
+    archive: boolean;
+}>;
+/**
+ * Unarchive a chat
+ *
+ * @alias archive
+ *
+ * @example
+ * ```javascript
+ * // Unarchive a chat
+ * WPP.chat.unarchive('[number]@c.us');
+ *
+ * // Alias for
+ * WPP.chat.archive('[number]@c.us', false);
+ * ```
+ * @category Chat
+ */
+export declare function unarchive(chatId: string | Wid): Promise<{
+    wid: Wid;
+    archive: boolean;
+}>;