@wppconnect/wa-js 3.1.0 → 3.2.0

package/CHANGELOG.md

@@ -1,9 +1,9 @@
-# 3.1.0 (2024-03-28)
+# 3.2.0 (2024-04-25)
 
 
-### Reverts
+### Features
 
-* Added template to changelog ([9ebf70b](https://github.com/wppconnect-team/wa-js/commit/9ebf70b6defd370eba39cc5786bcc49df6cb5b2a))
+* Added WPP.newsletter.getSubscribers function ([#1861](https://github.com/wppconnect-team/wa-js/issues/1861)) (close [#1746](https://github.com/wppconnect-team/wa-js/issues/1746)) ([31bdbb5](https://github.com/wppconnect-team/wa-js/commit/31bdbb5ea4aa94183b03ab0f636700d0f677aa08))
 
 
 

package/README.md

@@ -54,7 +54,7 @@ npm run wa-source
 # build javascript files
 npm run build:prd # or build:dev for development
 
-# lauch a local browser with automatic injection
+# launch a local browser with automatic injection
 npm run launch:local
 
 # or only run in VSCode

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2023 WPPConnect Team
+ * 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.
@@ -20,6 +20,7 @@ export interface ChatListOptions {
     direction?: 'after' | 'before';
     onlyCommunities?: boolean;
     onlyGroups?: boolean;
+    onlyNewsletter?: boolean;
     onlyUsers?: boolean;
     onlyWithUnreadMessage?: boolean;
     withLabels?: string[];
@@ -47,6 +48,9 @@ export interface ChatListOptions {
  * // Only communities chats
  * const chats = await WPP.chat.list({onlyCommunities: true});
  *
+ * // Only Newsletter
+ * const chats = await WPP.chat.list({onlyNewsletter: true});
+ *
  * // Only with label Text
  * const chats = await WPP.chat.list({withLabels: ['Test']});
  *

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

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

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

@@ -16,4 +16,5 @@
 export { create } from './create';
 export { destroy } from './destroy';
 export { edit } from './edit';
+export { getSubscribers } from './getSubscribers';
 export { mute } from './mute';

package/dist/whatsapp/collections/StatusCollection.d.ts

@@ -16,7 +16,10 @@
 import { Wid } from '../misc';
 import { StatusModel } from '../models';
 import { BaseCollection } from '.';
-/** @whatsapp 46133 */
+/**
+ * @whatsapp 46133
+ * @whatsapp WAWebTextStatusCollection >= 2.3000.1013010908
+ * */
 export declare class StatusCollection extends BaseCollection<StatusModel> {
     static model: StatusModel;
     static idClass: typeof Wid;

package/dist/whatsapp/functions/getNewsletterSubscribers.d.ts

@@ -0,0 +1,34 @@
+/*!
+ * 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.
+ */
+import { Wid } from '../misc';
+/**
+ * @whatsapp 276084
+ */
+export declare function getNewsletterSubscribers(jid: string, param2: number, view: 'LIMITED'): Promise<{
+    subscribers: {
+        id: Wid;
+        isContact?: boolean;
+        isGroup?: boolean;
+        isOnline?: boolean;
+        isUser?: boolean;
+        shortname?: string;
+        state?: string;
+        displayName?: string;
+        phoneNumber?: string;
+        subscribeTime?: number;
+        t: number;
+    }[];
+}>;

package/dist/whatsapp/functions/getTableVotes.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * 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.
+ */
+/**
+ * @whatsapp WAWebPollsVotesSchema => 2.3000.x
+ */
+export declare function getTableVotes(args?: any): any;

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

@@ -58,6 +58,7 @@ export * from './getGroupSenderKeyList';
 export * from './getGroupSizeLimit';
 export * from './getHistorySyncProgress';
 export * from './getMembershipApprovalRequests';
+export * from './getNewsletterSubscribers';
 export * from './getNextLabelId';
 export * from './getNumChatsPinned';
 export * from './getOrderInfo';
@@ -66,6 +67,7 @@ export * from './getPushname';
 export * from './getQuotedMsgObj';
 export * from './getReactions';
 export * from './getSearchContext';
+export * from './getTableVotes';
 export * from './getVotes';
 export * from './getWhatsAppWebExternalBetaJoinedIdb';
 export * from './GROUP_JID';
@@ -132,3 +134,4 @@ export * from './uploadMedia';
 export * from './uploadProductImage';
 export * from './uploadThumbnail';
 export * from './upsertVotes';
+export * from './voteFromDbRow';

package/dist/whatsapp/functions/sendNewsletterMessageJob.d.ts

@@ -13,12 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { MsgModel } from '../models';
 /** @whatsapp 397995
  */
 export declare function sendNewsletterMessageJob(data: {
-    msgData: any;
+    msgData?: any;
+    msg?: MsgModel;
     newsletterJid: string;
     type: string;
+    editType?: 'media' | 'text';
 }): Promise<{
     ack: {
         t: number;

package/dist/whatsapp/functions/voteFromDbRow.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * 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.
+ */
+import { MsgModel } from '../models';
+/**
+ * @whatsapp WAWebPollsDbSerialization >= 2.3000.x
+ */
+export declare function voteFromDbRow(msg: MsgModel): Promise<any>;