@wppconnect/wa-js 2.10.1 → 2.11.0

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+# 2.11.0 (2022-08-13)
+
 ## 2.10.1 (2022-08-09)
 
 # 2.10.0 (2022-08-04)

package/dist/assert/assertProduct.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * 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 { WPPError } from '../util';
+import { ProductModel } from '../whatsapp';
+export declare class InvalidProduct extends WPPError {
+    readonly id: string;
+    constructor(id: string);
+}
+export declare function assertGetProduct(productId: string): Promise<ProductModel>;

package/dist/assert/index.d.ts

@@ -16,4 +16,5 @@
 export * from './assertChat';
 export * from './assertColor';
 export * from './assertIsBusiness';
+export * from './assertProduct';
 export * from './assertWid';

package/dist/catalog/functions/addProductImage.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.
+ */
+/**
+ * Add image on product
+ * This function include additional images on product
+ * for change main image use @changeProductImage
+ *
+ * @example
+ * ```javascript
+ * await WPP.catalog.addProductImage('686859858689', 'data:image/jpeg;base64,.....');
+ * ```
+ *
+ * @category Catalog
+ */
+export declare function addProductImage(productId: string, content: string): Promise<any>;

package/dist/catalog/functions/changeProductImage.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.
+ */
+/**
+ * Add image on product
+ * This function change main image of product
+ * for change additional images use @addProductImage
+ *
+ * @example
+ * ```javascript
+ * await WPP.catalog.changeProductImage('686859858689', 'data:image/jpeg;base64,.....');
+ * ```
+ *
+ * @category Catalog
+ */
+export declare function changeProductImage(productId: string, content: string): Promise<any>;

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

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ */
+/**
+ * Create new collection
+ *
+ * @example
+ * ```javascript
+ * const myCatalog = await WPP.catalog.createCollection('Collection Name', ['565656589898']);
+ * ```
+ *
+ * @return Return collection created
+ */
+export declare function createCollection(collectionName: string, productsId: string[]): Promise<any>;

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

@@ -0,0 +1,47 @@
+/*!
+ * 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 { ProductModel } from '../../whatsapp';
+/**
+ * Create new product
+ *
+ * @example
+ * ```javascript
+ * const myCatalog = await WPP.catalog.addProduct(
+    {
+      name: 'Product name',
+      image: 'base64 image string',
+      description: 'product description',
+      price: '89.90',
+      isHidden: false,
+      url: 'https://wppconnect.io',
+      retailerId: 'AKA001',
+    }
+  );
+ * ```
+ *
+ * @return Your created product
+ */
+export interface createProductParams {
+    name: string;
+    image: string;
+    description?: string;
+    price?: number;
+    isHidden?: boolean;
+    url?: string;
+    retailerId?: string;
+    currency?: string;
+}
+export declare function createProduct(params: createProductParams): Promise<ProductModel>;

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

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ */
+/**
+ * Delete a collection
+ *
+ * @example
+ * ```javascript
+ * const myCatalog = await WPP.catalog.deleteCollection("377095767832354");
+ * ```
+ *
+ * @return Return sucess or error
+ */
+export declare function deleteCollection(collectionId: string): Promise<any>;

package/dist/catalog/functions/deleteProduct.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
+ * // Delete product by id
+ * const myCatalog = await WPP.catalog.delProducts('6104203702939361');
+ *
+ * // Delete various products
+ * const myCatalog = await WPP.catalog.delProducts(['6104203702939361', '6104289702939361']);
+ * ```
+ *
+ * @return Return sucess or error of product deleted
+ */
+export declare function delProducts(productsIds: string[]): Promise<any>;

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

@@ -0,0 +1,32 @@
+/*!
+ * 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.
+ */
+/**
+ * Create new collection
+ *
+ * @example
+ * ```javascript
+ * const myCatalog = await WPP.catalog.EditCollection('565656589898', { collectionName: 'New Name for collection', productsToAdd: ['5656523223'], productsToRemove: ['5656523232']});
+ * ```
+ *
+ * @return Return collection edited
+ */
+interface paramsEditCollection {
+    name?: string;
+    productsToAdd?: string[];
+    productsToRemove?: string[];
+}
+export declare function editCollection(collectionId: string, params: paramsEditCollection): Promise<any>;
+export {};

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

@@ -0,0 +1,36 @@
+/*!
+ * 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 { ProductModel } from '../../whatsapp';
+/**
+ * Get your current catalog
+ *
+ * @example
+ * ```javascript
+ * // Get your current catalog
+ * const myCatalog = WPP.catalog.editProduct('5498255476885590', {name: 'Plano 01', price: '89990', description: 'Insert description for your product', isHidden: true, url: 'http://www.wppconnect.io', retailerId: 'AKA001'});
+ * ```
+ *
+ * @return Return model of product edited
+ */
+export interface editProductParams {
+    name?: string;
+    description?: string;
+    price?: number;
+    isHidden?: boolean;
+    url?: string;
+    retailerId?: string;
+}
+export declare function editProduct(productId: string, params: editProductParams): Promise<ProductModel>;

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

@@ -0,0 +1,31 @@
+/*!
+ * 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 { ProductCollModel } from '../../whatsapp';
+/**
+ * Get collections of catalog
+ *
+ * @example
+ * ```javascript
+ * // Retrieve 20 collections of chat
+ * const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20');
+ *
+ * // Retrieve 20 collections of chat and products arrays limit with 10 products
+ * const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20', '10');
+ * ```
+ *
+ * @return Your collections of products
+ */
+export declare function getCollections(chatId: string, qnt?: number, productsCount?: number): Promise<ProductCollModel[]>;

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

@@ -13,4 +13,18 @@
  * 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/chat/functions/canMarkPlayed.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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 { Stringable } from '../../types';
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Get if message can played
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.canMarkPlayed('[message_id]');
+ * ```
+ * @category Message
+ */
+export declare function canMarkPlayed(messageId: string | MsgKey | MsgModel | Stringable): Promise<any>;

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

@@ -20,6 +20,7 @@ export interface GetMessagesOptions {
     direction?: 'after' | 'before';
     id?: string;
     onlyUnread?: boolean;
+    media?: 'url' | 'document' | 'all' | 'image';
 }
 /**
  * Fetch messages from a chat
@@ -54,6 +55,30 @@ export interface GetMessagesOptions {
  *   direction: 'before',
  *   id: '<full message id>'
  * });
+ *
+ * // Only media messages (url, document and links)
+ * WPP.chat.getMessages('[number]@c.us', {
+ *   count: 20,
+ *   media: 'all',
+ * });
+ *
+ * // Only image messages
+ * WPP.chat.getMessages('[number]@c.us', {
+ *   count: 20,
+ *   media: 'image',
+ * });
+ *
+ * // Only document messages
+ * WPP.chat.getMessages('[number]@c.us', {
+ *   count: 20,
+ *   media: 'document',
+ * });
+ *
+ * // Only link (url) messages
+ * WPP.chat.getMessages('[number]@c.us', {
+ *   count: 20,
+ *   media: 'url',
+ * });
  * ```
  * @category Message
  * @return  {RawMessage[]} List of raw messages

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

@@ -0,0 +1,34 @@
+/*!
+ * 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 { Stringable } from '../../types';
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Get the platform message from message ID
+ *
+ * The platform can be:
+ * * android
+ * * iphone
+ * * web
+ * * unknown
+ *
+ * @example
+ * ```javascript
+ * // to get platform from a message
+ * const platform = WPP.chat.getPlatformFromMessage('[message_id]');
+ * ```
+ * @category Message
+ */
+export declare function getPlatformFromMessage(messageId: string | MsgKey | MsgModel | Stringable): 'android' | 'iphone' | 'web' | 'unknown';

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 export { archive, unarchive } from './archive';
+export { canMarkPlayed } from './canMarkPlayed';
 export { canMute } from './canMute';
 export { clear } from './clear';
 export { delete } from './delete';
@@ -25,12 +26,14 @@ export { get } from './get';
 export { getLastSeen } from './getLastSeen';
 export { getMessageById } from './getMessageById';
 export { getMessages, GetMessagesOptions } from './getMessages';
+export { getPlatformFromMessage } from './getPlatformFromMessage';
 export { ChatListOptions, list } from './list';
 export { markIsComposing } from './markIsComposing';
 export { markIsPaused } from './markIsPaused';
 export { markIsRead } from './markIsRead';
 export { markIsRecording } from './markIsRecording';
 export { markIsUnread } from './markIsUnread';
+export { markPlayed } from './markPlayed';
 export { mute } from './mute';
 export { openChatAt } from './openChatAt';
 export { openChatBottom } from './openChatBottom';

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

@@ -0,0 +1,27 @@
+/*!
+ * 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 { Stringable } from '../../types';
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Mark message as played
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.markPlayed('[message_id]');
+ * ```
+ * @category Message
+ */
+export declare function markPlayed(messageId: string | MsgKey | MsgModel | Stringable): Promise<any>;