talkyzap-wapp-api 1.0.0

package/dist/labels/functions/deleteAllLabels.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 { DeleteLabelReturn } from '.';
+export declare function deleteAllLabels(): Promise<DeleteLabelReturn[]>;

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

@@ -0,0 +1,21 @@
+/*!
+ * 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.
+ */
+export interface DeleteLabelReturn {
+    id: string;
+    deleteLabelResult: any;
+}
+export declare function deleteLabel(id: string): Promise<DeleteLabelReturn>;
+export declare function deleteLabel(ids: string[]): Promise<DeleteLabelReturn[]>;

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

@@ -0,0 +1,37 @@
+/*!
+ * Copyright 2024 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 interface EditLabelOptions {
+    /**
+     * If it's decimal, send it as a number. If it's hexadecimal, send it as a string.
+     * If labelColor is omitted, the color will be generated automatically
+     */
+    labelColor?: string | number;
+    name?: string;
+}
+/**
+ * Edit a label
+ * For get a new color, use await WPP.labels.getLabelColorPalette() to get the list of available colors
+ * @example
+ * ```javascript
+ * await WPP.labels.editLabel(`Name of label`);
+ * //or
+ * await WPP.labels.editLabel(`Name of label`, { labelColor: '#dfaef0' });
+ * ```
+ * //or with color index
+ * await WPP.labels.editLabel(`Name of label`, { labelColor: 16 });
+ * ```
+ */
+export declare function editLabel(id: string, options?: EditLabelOptions): Promise<import("..").Label>;

package/dist/labels/functions/getAllLabels.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 { Label } from '..';
+export declare function getAllLabels(): Promise<Label[]>;

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/getLabelColorPalette.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.
+ */
+/**
+ * Returns an array of color palette in hex code
+ */
+export declare function getLabelColorPalette(): Promise<string[]>;

package/dist/labels/functions/getNewLabelColor.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.
+ */
+/**
+ * Return the color of the next label in positive decimal
+ */
+export declare function getNewLabelColor(): Promise<number>;

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

@@ -0,0 +1,25 @@
+/*!
+ * 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 { addNewLabel } from './addNewLabel';
+export { addOrRemoveLabels, AddOrRemoveLabelsOptions, } from './addOrRemoveLabels';
+export { colorIsInLabelPalette } from './colorIsInLabelPalette';
+export { deleteAllLabels } from './deleteAllLabels';
+export { deleteLabel, DeleteLabelReturn } from './deleteLabel';
+export { editLabel } from './editLabel';
+export { getAllLabels } from './getAllLabels';
+export { getLabelById } from './getLabelById';
+export { getLabelColorPalette } from './getLabelColorPalette';
+export { getNewLabelColor } from './getNewLabelColor';

package/dist/labels/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.
+ */
+export * from './functions';
+export * from './types';

package/dist/labels/types.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * 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 interface Label {
+    id: string;
+    name: string;
+    color: number | null;
+    count: number;
+    hexColor: string;
+    colorIndex: number;
+}

package/dist/newsletter/functions/create.d.ts

@@ -0,0 +1,42 @@
+/*!
+ * 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.
+ */
+export interface ResultCreateNewsletter {
+    idJid: string;
+    inviteCode: string;
+    inviteLink: string;
+    name: string;
+    state: string;
+    subscribersCount: number;
+    description: string | null;
+    timestamp: number;
+}
+/**
+ * Create a newsletter
+ *
+ * @example
+ * ```javascript
+ * // To edit name
+ * WPP.newsletter.create('Name for your newsletter', {
+ * description: 'Description for that',
+ * picture: '<base64_string',
+ * });
+ * ```
+ * @category Newsletter
+ */
+export declare function create(name: string, opts: {
+    description?: string;
+    picture?: string;
+}): Promise<ResultCreateNewsletter>;

package/dist/newsletter/functions/destroy.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ */
+/**
+ * Delete a newsletter
+ *
+ * @example
+ * ```javascript
+ * const code = WPP.newsletter.destroy('[newsletter-id]@newsletter');
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function destroy(id: string): Promise<boolean>;

package/dist/newsletter/functions/edit.d.ts

@@ -0,0 +1,58 @@
+/*!
+ * 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.
+ */
+export interface ResultCreateNewsletter {
+    idJid: string;
+    inviteCode: string;
+    inviteLink: string;
+    name: string;
+    state: string;
+    subscribersCount: number;
+    description: string | null;
+    timestamp: number;
+}
+/**
+ * Edit the newsletter data
+ *
+ * @example
+ * ```javascript
+ * // To edit name
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * name: 'New Name'
+ * });
+ *
+ * // To edit description
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * description: 'New description'
+ * });
+ *
+ * // To change picture
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * picture: '<base64_image>'
+ * });
+ *
+ * // To remove picture
+ * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
+ * picture: null
+ * });
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function edit(newsletterId: string, opts: {
+    name?: string;
+    description?: string;
+    picture?: string;
+}): Promise<ResultCreateNewsletter>;

package/dist/newsletter/functions/ensureNewsletter.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 { Wid } from '../../whatsapp';
+export declare function ensureNewsletter(newsletterId: string | Wid): Promise<import("../../whatsapp").ChatModel>;

package/dist/newsletter/functions/index.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.
+ */
+export { create } from './create';
+export { destroy } from './destroy';
+export { edit } from './edit';
+export { mute } from './mute';

package/dist/newsletter/functions/mute.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 { ChatModel } from '../../whatsapp';
+/**
+ * Mute and unmute a newsletter
+ *
+ * @example
+ * // Mute
+ * ```javascript
+ * WPP.newsletter.mute('[newsletter-id]@newsletter', true);
+ * ```
+ *
+ * // Unmute
+ * ```javascript
+ * WPP.newsletter.mute('[newsletter-id]@newsletter', false);
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function mute(newsletterId: string, value?: boolean): Promise<ChatModel>;

package/dist/newsletter/index.d.ts

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

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

@@ -0,0 +1,34 @@
+/*!
+ * 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 { MsgKey } from '../../whatsapp';
+export interface OrderEventTypes {
+    /**
+     * Triggered when change the active chat
+     *
+     * @example
+     * ```javascript
+     * WPP.on('order.payment_status', (order) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'order.payment_status': {
+        method: string;
+        timestamp: number;
+        reference_id: string;
+        msgId: MsgKey;
+    };
+}

package/dist/order/events/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.
+ */
+import './registerUpdateOrderEvent';

package/dist/order/events/registerUpdateOrderEvent.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 {};

package/dist/order/functions/get.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 { MsgKey } from '../../whatsapp';
+/**
+ * Get info of your sended order
+ *
+ * @example
+ * ```javascript
+ * const orderInfo = await WPP.order.get();
+ * ```
+ *
+ * @return Your current catalog
+ */
+export declare function get(msgId: string | MsgKey): Promise<boolean>;

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

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export { get } from './get';

package/dist/order/index.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.
+ */
+export * from './events';
+export * from './functions';