@wppconnect/wa-js 2.9.0 → 2.10.0

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+# 2.10.0 (2022-08-04)
+
 # 2.9.0 (2022-07-31)
 
 ## 2.8.2 (2022-07-12)

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/profile/functions/index.d.ts

@@ -14,5 +14,6 @@
  * limitations under the License.
  */
 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/whatsapp/functions/mediaTypeFromProtobuf.d.ts

@@ -19,4 +19,4 @@
  */
 export declare function mediaTypeFromProtobuf(protoMessage: {
     [key: string]: any;
-}): string;
+}): string | null;