@wppconnect/wa-js 2.10.0 → 2.11.1

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>;

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

@@ -37,7 +37,7 @@ export interface MessageButtonsOptions {
      * Set to use template buttons instead of reply buttons.
      * @default: undefined - auto detect
      */
-    useTemplateButtons?: boolean;
+    useTemplateButtons?: boolean | null;
     /**
      * Footer text for buttons
      */

package/dist/{config.d.ts → config/Config.d.ts}

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * 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.
@@ -28,6 +28,7 @@
  * ```
  */
 export interface Config {
+    [key: string | symbol]: any;
     /**
      * Set the device name connected, false to disable
      * @default 'WPPConnect'
@@ -60,5 +61,3 @@ export interface Config {
      */
     poweredBy: string | null;
 }
-export declare const defaultConfig: Config;
-export declare const config: Config;

package/dist/config/defaultConfig.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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 { Config } from './Config';
+export declare const defaultConfig: Config;

package/dist/config/eventTypes.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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 { Config } from './Config';
+export interface ConfigEventTypes {
+    'config.update': {
+        config: Config;
+        key: string | number | symbol;
+        path: (string | number | symbol)[];
+        target: any;
+        value: any;
+    };
+}

package/dist/config/index.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * 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 { Config } from './Config';
+export { Config } from './Config';
+declare global {
+    interface Window {
+        WPPConfig: Config;
+    }
+}
+export declare const config: Config;

package/dist/contact/functions/getBusinessProfile.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.
+ */
+import { BusinessProfileModel, Wid } from '../../whatsapp';
+/**
+ * Get the current text status
+ *
+ * @example
+ * ```javascript
+ * const url = await WPP.contact.getBusinessProfile('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function getBusinessProfile(contactId: string | Wid): Promise<BusinessProfileModel>;

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

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { getBusinessProfile } from './getBusinessProfile';
 export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
 export { ContactListOptions, list } from './list';

package/dist/eventEmitter/eventTypes.d.ts

@@ -16,6 +16,7 @@
 import { BlocklistEventTypes } from '../blocklist/events/eventTypes';
 import { CallEventTypes } from '../call/events/eventTypes';
 import { ChatEventTypes } from '../chat/events/eventTypes';
+import { ConfigEventTypes } from '../config/eventTypes';
 import { ConnEventTypes } from '../conn/events/eventTypes';
 import { GroupEventTypes } from '../group/events/eventTypes';
 import { StatusEventTypes } from '../status/events/eventTypes';
@@ -23,8 +24,9 @@ import { WebpackEvents } from '../webpack/eventTypes';
 export { BlocklistEventTypes } from '../blocklist/events/eventTypes';
 export { CallEventTypes } from '../call/events/eventTypes';
 export { ChatEventTypes } from '../chat/events/eventTypes';
+export { ConfigEventTypes } from '../config/eventTypes';
 export { ConnEventTypes } from '../conn/events/eventTypes';
 export { GroupEventTypes } from '../group/events/eventTypes';
 export { StatusEventTypes } from '../status/events/eventTypes';
 export { WebpackEvents } from '../webpack/eventTypes';
-export declare type EventTypes = BlocklistEventTypes & CallEventTypes & ChatEventTypes & ConnEventTypes & GroupEventTypes & StatusEventTypes & WebpackEvents;
+export declare type EventTypes = BlocklistEventTypes & CallEventTypes & ChatEventTypes & ConfigEventTypes & ConnEventTypes & GroupEventTypes & StatusEventTypes & WebpackEvents;