@wppconnect/wa-js 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.1.0 (2022-04-27)
+
+
+### Features
+
+* Added WPP.chat.sendLocationMessage function ([9503dcc](https://github.com/wppconnect-team/wa-js/commit/9503dccdb2b1cdb436db7c243b2852ee80267620))
+
+
+
 ## 2.0.2 (2022-04-26)
 
 

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

@@ -37,6 +37,7 @@ export { MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageB
 export { prepareRawMessage } from './prepareRawMessage';
 export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
 export { ListMessageOptions, sendListMessage } from './sendListMessage';
+export { LocationMessageOptions, sendLocationMessage, } from './sendLocationMessage';
 export { sendRawMessage } from './sendRawMessage';
 export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
 export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';

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

@@ -0,0 +1,100 @@
+/*!
+ * 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 { SendMessageOptions, SendMessageReturn } from '..';
+import { MessageButtonsOptions } from './prepareMessageButtons';
+export interface LocationMessageOptions extends SendMessageOptions, MessageButtonsOptions {
+    /**
+     * latitude in degrees
+     */
+    lat: number;
+    /**
+     * longitude in degrees
+     */
+    lng: number;
+    /**
+     * The full address of place
+     */
+    address?: string;
+    /**
+     * Name of the place
+     */
+    name?: string;
+    /**
+     * URL to open when click on the address/name
+     */
+    url?: string;
+}
+/**
+ * Send a location message
+ *
+ * @example
+ * ```javascript
+ * // full example
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ *  name: 'Cristo Rendentor', // optional
+ *  address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ', // optional
+ *  url: 'https://santuariocristoredentor.com.br/' // optional
+ * });
+ *
+ * // minimal
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ * });
+ *
+ * // name and address
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ *  name: 'Cristo Rendentor',
+ *  address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ'
+ * });
+ *
+ * // with buttons
+ * WPP.chat.sendLocationMessage('[number]@c.us', {
+ *  lat: -22.95201,
+ *  lng: -43.2102601,
+ *  name: 'Cristo Rendentor',
+ *  address: 'Parque Nacional da Tijuca - Alto da Boa Vista, Rio de Janeiro - RJ',
+ *  buttons: [
+ *      {
+ *          url: 'https://example.test/',
+ *          text: 'URL example'
+ *      },
+ *      {
+ *          phoneNumber: '+55 12 3456 7777',
+ *          text: 'Phone Number'
+ *      },
+ *      {
+ *          id: 'id1',
+ *          text: 'First'
+ *      },
+ *      {
+ *          id: 'id2',
+ *          text: 'Second'
+ *      },
+ *      {
+ *          id: 'other',
+ *          text: 'Other'
+ *      }
+ *  ],
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendLocationMessage(chatId: any, options: LocationMessageOptions): Promise<SendMessageReturn>;