@wppconnect/wa-js 3.23.1 → 4.0.2-alpha.0

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,14 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
+declare const labelsColorIsInLabelPaletteSchema: z.ZodObject<{
+    color: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+}, z.core.$strip>;
+export type LabelsColorIsInLabelPaletteInput = z.infer<typeof labelsColorIsInLabelPaletteSchema>;
+export type LabelsColorIsInLabelPaletteOutput = boolean;
 /**
  * Check if color is in label palette
- * @param color If it's decimal, send it as a number. If it's hexadecimal, send it as a string
  * @example
  * ```javascript
- * await WPP.labels.colorIsInLabelPalette('#ffd429');
+ * await WPP.labels.colorIsInLabelPalette({ color: '#ffd429' });
  * //or
- * await WPP.labels.colorIsInLabelPalette(4284794111);
+ * await WPP.labels.colorIsInLabelPalette({ color: 4284794111 });
  * ```
  */
-export declare function colorIsInLabelPalette(color: string | number): Promise<boolean>;
+export declare function colorIsInLabelPalette(params: LabelsColorIsInLabelPaletteInput): Promise<LabelsColorIsInLabelPaletteOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,4 +14,16 @@
  * limitations under the License.
  */
 import { DeleteLabelReturn } from '.';
-export declare function deleteAllLabels(): Promise<DeleteLabelReturn[]>;
+export type LabelsDeleteAllLabelsOutput = DeleteLabelReturn[];
+/**
+ * Delete all labels
+ *
+ * @example
+ * ```javascript
+ * const deleted = await WPP.labels.deleteAllLabels();
+ * console.log(deleted);
+ * ```
+ *
+ * @category Labels
+ */
+export declare function deleteAllLabels(): Promise<LabelsDeleteAllLabelsOutput>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,9 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
 export interface DeleteLabelReturn {
     id: string;
     deleteLabelResult: any;
 }
-export declare function deleteLabel(id: string): Promise<DeleteLabelReturn>;
-export declare function deleteLabel(ids: string[]): Promise<DeleteLabelReturn[]>;
+declare const labelsDeleteLabelSchema: z.ZodObject<{
+    labelIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type LabelsDeleteLabelInput = z.infer<typeof labelsDeleteLabelSchema>;
+export type LabelsDeleteLabelOutput = DeleteLabelReturn[];
+export declare function deleteLabel(params: LabelsDeleteLabelInput): Promise<LabelsDeleteLabelOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2024 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,25 +13,27 @@
  * 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;
-}
+import { z } from 'zod';
+import { Label } from '..';
+declare const labelsEditLabelSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    labelColor: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+}, z.core.$strip>;
+export type LabelsEditLabelInput = z.infer<typeof labelsEditLabelSchema>;
+export type LabelsEditLabelOutput = Label;
 /**
  * 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`);
+ * await WPP.labels.editLabel({ id: 'labelId' });
  * //or
- * await WPP.labels.editLabel(`Name of label`, { labelColor: '#dfaef0' });
+ * await WPP.labels.editLabel({ id: 'labelId', labelColor: '#dfaef0' });
  * ```
  * //or with color index
- * await WPP.labels.editLabel(`Name of label`, { labelColor: 16 });
+ * await WPP.labels.editLabel({ id: 'labelId', labelColor: 16 });
  * ```
  */
-export declare function editLabel(id: string, options?: EditLabelOptions): Promise<import("..").Label>;
+export declare function editLabel(params: LabelsEditLabelInput): Promise<LabelsEditLabelOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,4 +14,16 @@
  * limitations under the License.
  */
 import { Label } from '..';
-export declare function getAllLabels(): Promise<Label[]>;
+export type LabelsGetAllLabelsOutput = Label[];
+/**
+ * Get all labels
+ *
+ * @example
+ * ```javascript
+ * const labels = await WPP.labels.getAllLabels();
+ * console.log(labels);
+ * ```
+ *
+ * @category Labels
+ */
+export declare function getAllLabels(): Promise<LabelsGetAllLabelsOutput>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2022 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,5 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
 import { Label } from '..';
-export declare function getLabelById(labelId: string): Promise<Label>;
+declare const labelsGetLabelByIdSchema: z.ZodObject<{
+    labelId: z.ZodString;
+}, z.core.$strip>;
+export type LabelsGetLabelByIdInput = z.infer<typeof labelsGetLabelByIdSchema>;
+export type LabelsGetLabelByIdOutput = Label;
+export declare function getLabelById(params: LabelsGetLabelByIdInput): Promise<LabelsGetLabelByIdOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export type LabelsGetLabelColorPaletteOutput = string[];
 /**
  * Returns an array of color palette in hex code
+ *
+ * @example
+ * ```javascript
+ * const palette = await WPP.labels.getLabelColorPalette();
+ * console.log(palette);
+ * ```
+ *
+ * @category Labels
  */
-export declare function getLabelColorPalette(): Promise<string[]>;
+export declare function getLabelColorPalette(): Promise<LabelsGetLabelColorPaletteOutput>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export type LabelsGetNewLabelColorOutput = number;
 /**
- * Return the color of the next label in positive decimal
+ * Return the color index of the next available label
+ *
+ * @example
+ * ```javascript
+ * const color = await WPP.labels.getNewLabelColor();
+ * console.log(color);
+ * ```
+ *
+ * @category Labels
  */
-export declare function getNewLabelColor(): Promise<number>;
+export declare function getNewLabelColor(): Promise<LabelsGetNewLabelColorOutput>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,13 +13,13 @@
  * 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';
+export { addNewLabel, LabelsAddNewLabelInput, LabelsAddNewLabelOutput, } from './addNewLabel';
+export { addOrRemoveLabels, LabelsAddOrRemoveLabelsInput, LabelsAddOrRemoveLabelsOutput, } from './addOrRemoveLabels';
+export { colorIsInLabelPalette, LabelsColorIsInLabelPaletteInput, LabelsColorIsInLabelPaletteOutput, } from './colorIsInLabelPalette';
+export { deleteAllLabels, LabelsDeleteAllLabelsOutput, } from './deleteAllLabels';
+export { deleteLabel, DeleteLabelReturn, LabelsDeleteLabelInput, LabelsDeleteLabelOutput, } from './deleteLabel';
+export { editLabel, LabelsEditLabelInput, LabelsEditLabelOutput, } from './editLabel';
+export { getAllLabels, LabelsGetAllLabelsOutput } from './getAllLabels';
+export { getLabelById, LabelsGetLabelByIdInput, LabelsGetLabelByIdOutput, } from './getLabelById';
+export { getLabelColorPalette, LabelsGetLabelColorPaletteOutput, } from './getLabelColorPalette';
+export { getNewLabelColor, LabelsGetNewLabelColorOutput, } from './getNewLabelColor';

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface ResultCreateNewsletter {
+import { z } from 'zod';
+declare const newsletterCreateSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    picture: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type NewsletterCreateInput = z.infer<typeof newsletterCreateSchema>;
+export type NewsletterCreateOutput = {
     idJid: string;
     inviteCode: string;
     inviteLink: string;
@@ -22,21 +29,19 @@ export interface ResultCreateNewsletter {
     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',
+ * WPP.newsletter.create({
+ *   name: '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>;
+export declare function create(params: NewsletterCreateInput): Promise<NewsletterCreateOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,14 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
+declare const newsletterDestroySchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+}, z.core.$strip>;
+export type NewsletterDestroyInput = z.infer<typeof newsletterDestroySchema>;
+export type NewsletterDestroyOutput = boolean;
 /**
  * Delete a newsletter
  *
  * @example
  * ```javascript
- * const code = WPP.newsletter.destroy('[newsletter-id]@newsletter');
+ * const code = WPP.newsletter.destroy({ newsletterId: '[newsletter-id]@newsletter' });
  * ```
  *
  * @category Newsletter
  */
-export declare function destroy(id: string): Promise<boolean>;
+export declare function destroy(params: NewsletterDestroyInput): Promise<NewsletterDestroyOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface ResultCreateNewsletter {
+import { z } from 'zod';
+declare const newsletterEditSchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    picture: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type NewsletterEditInput = z.infer<typeof newsletterEditSchema>;
+export type NewsletterEditOutput = {
     idJid: string;
     inviteCode: string;
     inviteLink: string;
@@ -22,37 +30,38 @@ export interface ResultCreateNewsletter {
     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'
+ * const code = WPP.newsletter.edit({
+ *   newsletterId: '[newsletter-id]@newsletter',
+ *   name: 'New Name'
  * });
  *
  * // To edit description
- * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
- * description: 'New description'
+ * const code = WPP.newsletter.edit({
+ *   newsletterId: '[newsletter-id]@newsletter',
+ *   description: 'New description'
  * });
  *
  * // To change picture
- * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
- * picture: '<base64_image>'
+ * const code = WPP.newsletter.edit({
+ *   newsletterId: '[newsletter-id]@newsletter',
+ *   picture: '<base64_image>'
  * });
  *
  * // To remove picture
- * const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
- * picture: null
+ * const code = WPP.newsletter.edit({
+ *   newsletterId: '[newsletter-id]@newsletter',
+ *   picture: null
  * });
  * ```
  *
  * @category Newsletter
  */
-export declare function edit(newsletterId: string, opts: {
-    name?: string;
-    description?: string;
-    picture?: string;
-}): Promise<ResultCreateNewsletter>;
+export declare function edit(params: NewsletterEditInput): Promise<NewsletterEditOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,5 +13,10 @@
  * 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>;
+import z from 'zod';
+declare const newsletterEnsureNewsletterSchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+}, z.core.$strip>;
+export type NewsletterEnsureNewsletterInput = z.infer<typeof newsletterEnsureNewsletterSchema>;
+export declare function ensureNewsletter(params: NewsletterEnsureNewsletterInput): Promise<import("../../whatsapp").ChatModel>;
+export {};

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

@@ -13,15 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
+declare const newsletterFollowSchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+}, z.core.$strip>;
+export type NewsletterFollowInput = z.infer<typeof newsletterFollowSchema>;
+export type NewsletterFollowOutput = boolean;
 /**
  * Follow/subscribe to a newsletter
  *
  * @example
  * ```javascript
  * // Follow a newsletter
- * const success = await WPP.newsletter.follow('120363xxxxx@newsletter');
+ * const success = await WPP.newsletter.follow({ newsletterId: '120363xxxxx@newsletter' });
  * ```
  *
  * @category Newsletter
  */
-export declare function follow(id: string): Promise<boolean>;
+export declare function follow(params: NewsletterFollowInput): Promise<NewsletterFollowOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2024 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,14 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
+declare const newsletterGetSubscribersSchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+}, z.core.$strip>;
+export type NewsletterGetSubscribersInput = z.infer<typeof newsletterGetSubscribersSchema>;
+export type NewsletterGetSubscribersOutput = any;
 /**
  * Get subscribers of a newsletters
  *
  * @example
  * ```javascript
- * const code = WPP.newsletter.getSubscribers('[newsletter-id]@newsletter');
+ * const code = WPP.newsletter.getSubscribers({ newsletterId: '[newsletter-id]@newsletter' });
  * ```
  *
  * @category Newsletter
  */
-export declare function getSubscribers(id: string): Promise<any>;
+export declare function getSubscribers(params: NewsletterGetSubscribersInput): Promise<NewsletterGetSubscribersOutput>;
+export {};

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2022 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,11 +13,11 @@
  * 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 { follow } from './follow';
-export { getSubscribers } from './getSubscribers';
-export { mute } from './mute';
-export { search } from './search';
-export { unfollow } from './unfollow';
+export { create, NewsletterCreateInput, NewsletterCreateOutput, } from './create';
+export { destroy, NewsletterDestroyInput, NewsletterDestroyOutput, } from './destroy';
+export { edit, NewsletterEditInput, NewsletterEditOutput } from './edit';
+export { follow, NewsletterFollowInput, NewsletterFollowOutput, } from './follow';
+export { getSubscribers, NewsletterGetSubscribersInput, NewsletterGetSubscribersOutput, } from './getSubscribers';
+export { mute, NewsletterMuteInput, NewsletterMuteOutput } from './mute';
+export { NewsletterSearchInput, NewsletterSearchOutput, search, } from './search';
+export { NewsletterUnfollowInput, NewsletterUnfollowOutput, unfollow, } from './unfollow';

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * Copyright 2026 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,21 +13,29 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
 import { ChatModel } from '../../whatsapp';
+declare const newsletterMuteSchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+    value: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type NewsletterMuteInput = z.infer<typeof newsletterMuteSchema>;
+export type NewsletterMuteOutput = ChatModel;
 /**
  * Mute and unmute a newsletter
  *
  * @example
  * // Mute
  * ```javascript
- * WPP.newsletter.mute('[newsletter-id]@newsletter', true);
+ * WPP.newsletter.mute({ newsletterId: '[newsletter-id]@newsletter', value: true });
  * ```
  *
  * // Unmute
  * ```javascript
- * WPP.newsletter.mute('[newsletter-id]@newsletter', false);
+ * WPP.newsletter.mute({ newsletterId: '[newsletter-id]@newsletter', value: false });
  * ```
  *
  * @category Newsletter
  */
-export declare function mute(newsletterId: string, value?: boolean): Promise<ChatModel>;
+export declare function mute(params: NewsletterMuteInput): Promise<NewsletterMuteOutput>;
+export {};

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

@@ -13,12 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface NewsletterSearchOptions {
-    categories?: string[];
-    limit?: number;
-    cursorToken?: string;
-}
-export interface NewsletterSearchResult {
+import { z } from 'zod';
+declare const newsletterSearchSchema: z.ZodObject<{
+    query: z.ZodString;
+    categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    cursorToken: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type NewsletterSearchInput = z.infer<typeof newsletterSearchSchema>;
+export type NewsletterSearchOutput = {
     newsletters: Array<{
         idJid: string;
         name: string;
@@ -35,25 +38,27 @@ export interface NewsletterSearchResult {
         hasNextPage?: boolean;
         endCursor?: string;
     };
-}
+};
 /**
  * Search for newsletters in the directory
  *
  * @example
  * ```javascript
  * // Basic search
- * const result = await WPP.newsletter.search('technology');
+ * const result = await WPP.newsletter.search({ query: 'technology' });
  *
  * // Search with options
- * const result = await WPP.newsletter.search('news', {
+ * const result = await WPP.newsletter.search({
+ *   query: 'news',
  *   limit: 10,
  *   categories: ['TECHNOLOGY', 'NEWS']
  * });
  *
  * // Pagination
- * const firstPage = await WPP.newsletter.search('tech');
+ * const firstPage = await WPP.newsletter.search({ query: 'tech' });
  * if (firstPage.pageInfo?.hasNextPage) {
- *   const nextPage = await WPP.newsletter.search('tech', {
+ *   const nextPage = await WPP.newsletter.search({
+ *     query: 'tech',
  *     cursorToken: firstPage.pageInfo.endCursor
  *   });
  * }
@@ -61,4 +66,5 @@ export interface NewsletterSearchResult {
  *
  * @category Newsletter
  */
-export declare function search(query: string, options?: NewsletterSearchOptions): Promise<NewsletterSearchResult>;
+export declare function search(params: NewsletterSearchInput): Promise<NewsletterSearchOutput>;
+export {};

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

@@ -13,15 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
+declare const newsletterUnfollowSchema: z.ZodObject<{
+    newsletterId: z.ZodString;
+}, z.core.$strip>;
+export type NewsletterUnfollowInput = z.infer<typeof newsletterUnfollowSchema>;
+export type NewsletterUnfollowOutput = boolean;
 /**
  * Unfollow/unsubscribe from a newsletter
  *
  * @example
  * ```javascript
  * // Unfollow a newsletter
- * const success = await WPP.newsletter.unfollow('120363xxxxx@newsletter');
+ * const success = await WPP.newsletter.unfollow({ newsletterId: '120363xxxxx@newsletter' });
  * ```
  *
  * @category Newsletter
  */
-export declare function unfollow(id: string): Promise<boolean>;
+export declare function unfollow(params: NewsletterUnfollowInput): Promise<NewsletterUnfollowOutput>;
+export {};