talkyzap-wapp-api 1.0.0

package/dist/blocklist/types.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 { Wid } from '../whatsapp';
+export interface BlocklistResult {
+    wid: Wid;
+    isBlocked: boolean;
+}

package/dist/call/events/eventTypes.d.ts

@@ -0,0 +1,56 @@
+/*!
+ * 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';
+export interface CallEventTypes {
+    /**
+     * Triggered when you a incoming call
+     *
+     * @example
+     * ```javascript
+     * WPP.on('call.incoming_call', (call) => {
+     *   // Your code
+     *   //Example: Reject any incoming call
+     *   WPP.call.rejectCall(call.id);
+     * });
+     * ```
+     */
+    'call.incoming_call': {
+        /**
+         * The call id
+         */
+        id: string;
+        /**
+         * Is a call from a group
+         */
+        isGroup: boolean;
+        /**
+         * Is call with video
+         */
+        isVideo: boolean;
+        /**
+         * timestamp of offer
+         */
+        offerTime: number;
+        /**
+         * Wid of sender without device id
+         */
+        sender: Wid;
+        /**
+         * Wid of sender with device id
+         */
+        peerJid: Wid;
+    };
+}

package/dist/call/events/index.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.
+ */
+import './registerIncomingCallEvent';

package/dist/call/events/registerIncomingCallEvent.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/call/functions/accept.d.ts

@@ -0,0 +1,38 @@
+/*!
+ * 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.
+ */
+/**
+ * Accept a incoming call
+ *
+ * @example
+ * ```javascript
+ * // Accept any incoming call
+ * WPP.call.accept();
+ *
+ * // Accept specific call id
+ * WPP.call.accept(callId);
+ *
+ * // Accept any incoming call
+ * WPP.on('call.incoming_call', (call) => {
+ *   setTimeout(() => {
+ *     WPP.call.accept(call.id);
+ *   }, 1000);
+ * });
+ * ```
+ *
+ * @param   {string}  callId  The call ID, empty to accept the first one
+ * @return  {[type]}          [return description]
+ */
+export declare function accept(callId?: string): Promise<boolean>;

package/dist/call/functions/end.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright 2023 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.
+ */
+/**
+ * End a outcoming call
+ *
+ * @example
+ * ```javascript
+ * // End any outcoming call
+ * WPP.call.end();
+ *
+ * // End specific call id
+ * WPP.call.end(callId);
+ *
+ * // End any outcoming call
+ * WPP.on('call.outcoming_call', (call) => {
+ *   WPP.call.end(call.id);
+ * });
+ * ```
+ *
+ * @param   {string}  callId  The call ID, empty to end the first one
+ * @return  {[type]}          [return description]
+ */
+export declare function end(callId?: string): Promise<boolean>;

package/dist/call/functions/index.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.
+ */
+export { accept } from './accept';
+export { end } from './end';
+export { offer } from './offer';
+export { reject, reject as rejectCall } from './reject';

package/dist/call/functions/offer.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright 2023 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';
+export interface CallOfferOptions {
+    isVideo?: boolean;
+}
+/**
+ * Send a call offer
+ *
+ * This method only will send a call offer, but there are no audio/video
+ *
+ * @example
+ * ```javascript
+ * // Send a call offer
+ * WPP.call.offer('[number]@c.us');
+ * // Send a video call offer
+ * WPP.call.offer('[number]@c.us', {isVideo: true});
+ * ```
+ */
+export declare function offer(to: string | Wid, options?: CallOfferOptions): Promise<any>;

package/dist/call/functions/parseRelayResponse.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2023 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 { websocket } from '../../whatsapp';
+export declare function parseRelayResponse(response: websocket.WapNode): {
+    rte: {
+        ip: number[];
+        port: number;
+    } | null;
+    key: string;
+    relays: {
+        [key: string]: {
+            ip: number[];
+            port: number;
+            relay_id: string;
+            token: string;
+        };
+    };
+};

package/dist/call/functions/prepareDestination.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2023 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 { websocket, Wid } from '../../whatsapp';
+export declare function prepareDestionation(wids: Wid[], encKey: ArrayBufferLike): Promise<websocket.WapNode[]>;

package/dist/call/functions/reject.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * 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.
+ */
+/**
+ * Reject a incoming call
+ *
+ * @example
+ * ```javascript
+ * // Reject any incoming call
+ * WPP.call.reject();
+ *
+ * // Reject specific call id
+ * WPP.call.reject(callId);
+ *
+ * // Reject any incoming call
+ * WPP.on('call.incoming_call', (call) => {
+ *   WPP.call.reject(call.id);
+ * });
+ * ```
+ *
+ * @param   {string}  callId  The call ID, empty to reject the first one
+ * @return  {[type]}          [return description]
+ */
+export declare function reject(callId?: string): Promise<boolean>;

package/dist/call/index.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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 './events';
+export * from './functions';

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,37 @@
+/*!
+ * 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;
+    image?: 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/getMyCatalog.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.
+ */
+/**
+ * Get your current catalog
+ *
+ * @example
+ * ```javascript
+ * // Get your current catalog
+ * const myCatalog = await WPP.catalog.getMyCatalog();
+ * ```
+ *
+ * @return Your current catalog
+ */
+export declare function getMyCatalog(): Promise<import("../../whatsapp").CatalogModel | undefined>;