@wppconnect/wa-js 2.9.0 → 2.11.0

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

@@ -18,6 +18,37 @@ export declare type TextMessageOptions = SendMessageOptions & MessageButtonsOpti
 /**
  * Send a text message
  *
+ * @example
+ * ```javascript
+ * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
+ *   createChat: true
+ * });
+ *
+ * // With Buttons
+ * WPP.chat.sendTextMessage('[number]@c.us', 'Hello', {
+ *   useTemplateButtons: true, // False for legacy
+ *   buttons: [
+ *     {
+ *       url: 'https://wppconnect.io/',
+ *       text: 'WPPConnect Site'
+ *     },
+ *     {
+ *       phoneNumber: '+55 11 22334455',
+ *       text: 'Call me'
+ *     },
+ *     {
+ *       id: 'your custom id 1',
+ *       text: 'Some text'
+ *     },
+ *     {
+ *       id: 'another id 2',
+ *       text: 'Another text'
+ *     }
+ *   ],
+ *   title: 'Title text', // Optional
+ *   footer: 'Footer text' // Optional
+ * });
+ * ```
  * @category Message
  */
 export declare function sendTextMessage(chatId: any, content: any, options?: TextMessageOptions): Promise<SendMessageReturn>;

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

@@ -21,7 +21,27 @@ export interface VCardContact {
 }
 /**
  * Send a VCard as message
+ * @example
+ * ```javascript
+ * // single contact
+ * WPP.chat.sendVCardContactMessage('[number]@c.us', {
+ *   id: '123456@c.us',
+ *   name: 'The Contact Name'
+ * });
  *
+ * // multiple contacts
+ * WPP.chat.sendVCardContactMessage('[number]@c.us', [
+ *   {
+ *     id: '123456@c.us',
+ *     name: 'The Contact Name'
+ *   },
+ *   {
+ *     id: '456789@c.us',
+ *     name: 'Another Contact'
+ *   },
+ * ]);
+ *
+ * ```
  * @category Message
  */
 export declare function sendVCardContactMessage(chatId: any, contacts: string | Wid | VCardContact | (string | Wid | VCardContact)[], options?: SendMessageOptions): Promise<SendMessageReturn>;

package/dist/chat/index.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import './events';
+import './patch';
 export * from './defaultSendMessageOptions';
 export * from './functions';
 export * from './types';

package/dist/chat/patch.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/conn/functions/getPlatform.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.
+ */
+/**
+ * Check what's device platform is connected
+ * @returns android | iphone | wp
+ *
+ * @example
+ * ```javascript
+ * const getPlatform = WPP.conn.getPlatform();
+ * ```
+ */
+export declare function getPlatform(): any;

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

@@ -16,9 +16,11 @@
 export { getAuthCode } from './getAuthCode';
 export { getMyDeviceId } from './getMyDeviceId';
 export { getMyUserId } from './getMyUserId';
+export { getPlatform } from './getPlatform';
 export { isAuthenticated } from './isAuthenticated';
 export { isIdle } from './isIdle';
 export { isMainLoaded } from './isMainLoaded';
+export { isMainReady } from './isMainReady';
 export { isMultiDevice } from './isMultiDevice';
 export { logout } from './logout';
 export { refreshQR } from './refreshQR';

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/labels/functions/getLabelById.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 { Label } from '..';
+export declare function getLabelById(labelId: string): Promise<Label>;

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

@@ -19,5 +19,6 @@ export { colorIsInLabelPalette } from './colorIsInLabelPalette';
 export { deleteAllLabels } from './deleteAllLabels';
 export { deleteLabel, DeleteLabelReturn } from './deleteLabel';
 export { getAllLabels } from './getAllLabels';
+export { getLabelById } from './getLabelById';
 export { getLabelColorPalette } from './getLabelColorPalette';
 export { getNewLabelColor } from './getNewLabelColor';

package/dist/profile/functions/editBusinessProfile.d.ts

@@ -0,0 +1,177 @@
+/*!
+ * 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 } from '../../whatsapp';
+/**
+ * Update your business profile
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({description: 'New description for profile'});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({categories: {
+    id: "133436743388217",
+    localized_display_name: "Artes e entretenimento",
+    not_a_biz: false,
+  }});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({adress: 'Street 01, New York'});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({adress: 'Street 01, New York'});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({email: 'test@test.com.br'});
+ * ```
+ *
+ * Change website of profile (max 2 sites)
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({website: [
+  "https://www.wppconnect.io",
+  "https://www.teste2.com.br",
+]});
+ * ```
+ *
+ * Change businessHours for Specific Hours
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({ businessHours: {
+ * {
+      tue: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      wed: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      thu: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      fri: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      sat: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      sun: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+    }
+  },
+  timezone: "America/Sao_Paulo"
+  });
+ *
+ * Change businessHours for Always Opened
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({ businessHours: {
+    {
+      mon: {
+        mode: "open_24h",
+      },
+      tue: {
+        mode: "open_24h",
+      },
+      wed: {
+        mode: "open_24h",
+      },
+      thu: {
+        mode: "open_24h",
+      },
+      fri: {
+        mode: "open_24h",
+      },
+      sat: {
+        mode: "open_24h",
+      },
+      sun: {
+        mode: "open_24h",
+      },
+    }
+    timezone: "America/Sao_Paulo"
+  });
+ *
+ * Change businessHours for Appointment Only
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({ businessHours: { {
+    mon: {
+      mode: "appointment_only",
+    },
+    tue: {
+      mode: "appointment_only",
+    },
+    wed: {
+      mode: "appointment_only",
+    },
+    thu: {
+      mode: "appointment_only",
+    },
+    fri: {
+      mode: "appointment_only",
+    },
+    sat: {
+      mode: "appointment_only",
+    },
+    sun: {
+      mode: "appointment_only",
+    },
+  }
+    timezone: "America/Sao_Paulo"
+  });
+ *
+ *
+ * ```
+ * @category Profile
+ */
+export declare function editBusinessProfile(params: BusinessProfileModel): Promise<any>;

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

@@ -13,6 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { editBusinessProfile } from './editBusinessProfile';
 export { getMyStatus } from './getMyStatus';
+export { isBusiness } from './isBusiness';
 export { setMyProfilePicture } from './setMyProfilePicture';
 export { setMyStatus } from './setMyStatus';

package/dist/profile/functions/isBusiness.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * 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.
+ */
+/**
+ * Return the current logged user is Bussiness or not
+ *
+ * @example
+ * ```javascript
+ * WPP.profile.isBusiness();
+ * ```
+ */
+export declare function isBusiness(): boolean | undefined;

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

@@ -17,5 +17,6 @@ export { get } from './get';
 export { getMyStatus } from './getMyStatus';
 export { ImageStatusOptions, sendImageStatus } from './sendImageStatus';
 export { sendRawStatus, SendStatusOptions } from './sendRawStatus';
+export { sendReadStatus } from './sendReadStatus';
 export { sendTextStatus, TextStatusOptions } from './sendTextStatus';
 export { sendVideoStatus, VideoStatusOptions } from './sendVideoStatus';

package/dist/status/functions/sendReadStatus.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 { Wid } from '../../whatsapp';
+/**
+ * Mark status as read/seen
+ *
+ * @example
+ * ```javascript
+ * WPP.status.sendReadStatus('[phone_number]@c.us', 'false_status@broadcast_3A169E0FD4BC6E92212F_5521526232927@c.us');
+ * ```
+ */
+export declare function sendReadStatus(chatId: string | Wid, statusId: string): Promise<any>;

package/dist/whatsapp/collections/CatalogCollection.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Wid } from '../misc';
 import { CatalogModel } from '../models';
 import { Collection } from './Collection';
 /** @whatsapp 99989
@@ -25,9 +26,10 @@ export declare class CatalogCollection extends Collection<CatalogModel> {
     findProduct(e?: {
         catalogWid: any;
         productId: any;
-        productMsgMediaData: any;
+        productMsgMediaData?: any;
     }): any;
     findCarouselCatalog(e?: any): any;
     findNextProductPage(e?: any): any;
     findCollectionMembership(e?: any, t?: any): any;
+    _queryCatalog(e?: CatalogModel, t?: Wid, n?: any, r?: any, a?: any, o?: any): any;
 }

package/dist/whatsapp/contants/DROP_ATTR.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.
+ */
+/**
+ *  @whatsapp 831914
+ */
+export declare const DROP_ATTR: any;

package/dist/whatsapp/contants/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 './DROP_ATTR';

package/dist/whatsapp/enums/CALL_STATES.d.ts

@@ -16,6 +16,7 @@
 /**
  * @whatsapp 49835
  * @whatsapp 749835 >= 2.2222.8
+ * @whatsapp 873297 >= 2.2230.8
  */
 export declare enum CALL_STATES {
     INCOMING_RING = "INCOMING_RING",

package/dist/whatsapp/enums/SendMsgResult.d.ts

@@ -15,6 +15,7 @@
  */
 /** @whatsapp 13705
  * @whatsapp 413705 >= 2.2222.8
+ * @whatsapp 20551 >= 2.2228.4
  */
 export declare enum SendMsgResult {
     OK = "OK",

package/dist/whatsapp/functions/addAndSendMsgToChat.d.ts

@@ -17,5 +17,6 @@ import { SendMsgResult } from '../enums';
 import { ChatModel, ModelPropertiesContructor, MsgModel } from '../models';
 /** @whatsapp 75887
  * @whatsapp 975887 >= 2.2222.8
+ * @whatsapp 623631 >= 2.2228.4
  */
 export declare function addAndSendMsgToChat(chat: ChatModel, message: ModelPropertiesContructor<MsgModel>): Promise<[Promise<MsgModel>, Promise<SendMsgResult>]>;

package/dist/whatsapp/functions/blockContact.d.ts

@@ -16,9 +16,11 @@
 import { ContactModel } from '../models';
 /** @whatsapp 80140
  * @whatsapp 780140 >= 2.2222.8
+ * @whatsapp 48826 >= 2.2228.4
  */
 export declare function blockContact(contact: ContactModel): Promise<void>;
 /** @whatsapp 80140
  * @whatsapp 780140 >= 2.2222.8
+ * @whatsapp 48826 >= 2.2228.4
  */
 export declare function unblockContact(contact: ContactModel): Promise<void>;

package/dist/whatsapp/functions/calculateFilehashFromBlob.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * 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.
+ */
+/**
+ * @whatsapp 818309 >= 2.2228.14
+ */
+export declare function calculateFilehashFromBlob(file: Blob): Promise<string>;

package/dist/whatsapp/functions/collections.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * 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 '../misc';
+/** @whatsapp 409465 >= 2.2228.14
+ */
+export declare function createCollection(...args: any[]): Promise<any>;
+/** @whatsapp 409465 >= 2.2228.14
+ */
+export declare function deleteCollection(id: string, sessionId: string): Promise<any>;
+/** @whatsapp 409465 >= 2.2228.14
+ */
+export declare function editCollection(collectionId: string, collectionName: string | undefined, collectionBoolea: boolean, productsToAdd: string[], productsToRemove: string[], sessionId: string): Promise<any>;
+export interface QueryCollectionsIQtParams {
+    afterCursor?: string;
+    catalogWid?: Wid;
+    directConnectionEncryptedInfo?: any;
+    height?: 100;
+    width?: 100;
+    limit: number;
+    productsCount?: number;
+}
+/** @whatsapp 409465 >= 2.2228.14
+ */
+export declare function queryCollectionsIQ(params: QueryCollectionsIQtParams): any;

package/dist/whatsapp/functions/createMsgProtobuf.d.ts

@@ -16,6 +16,7 @@
 import { MsgModel } from '..';
 /** @whatsapp 6565
  * @whatsapp 606565 >= 2.2222.8
+ * @whatsapp 615947 >= 2.2228.4
  */
 export declare function createMsgProtobuf(e: MsgModel, t?: {
     [key: string]: any;

package/dist/whatsapp/functions/editBusinessProfile.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * 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 } from '../models';
+/**
+ * @whatsapp 461561
+ */
+export declare function editBusinessProfile(arguments: BusinessProfileModel): Promise<any>;

package/dist/whatsapp/functions/encodeMaybeMediaType.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.
+ */
+/**
+ * @whatsapp 760210
+ */
+export declare function encodeMaybeMediaType(type: string): string | undefined;

package/dist/whatsapp/functions/encryptAndSendGroupMsg.d.ts

@@ -17,5 +17,6 @@ import { MsgModel } from '../models';
 /**
  * @whatsapp 51974
  * @whatsapp 951974 >= 2.2222.8
+ * @whatsapp 677020 >= 2.2228.4
  */
 export declare function encryptAndSendGroupMsg(message: MsgModel, protobuf: any): Promise<any>;

package/dist/whatsapp/functions/encryptAndSendMsg.d.ts

@@ -17,5 +17,6 @@ import { MsgModel } from '../models';
 /**
  * @whatsapp 95547
  * @whatsapp 695547 >= 2.2222.8
+ * @whatsapp 925080 >= 2.2228.4
  */
 export declare function encryptAndSendMsg(message: MsgModel): Promise<any>;