@open-wa/wa-automate-types-only 4.48.0 → 4.48.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -208,7 +208,8 @@ export declare class Client {
208
208
  */
209
209
  onPlugged(fn: (plugged: boolean) => void): Promise<Listener | boolean>;
210
210
  /**
211
- * Requires a Story License Key
211
+ * {@license:restricted@}
212
+ *
212
213
  * Listens to when a contact posts a new story.
213
214
  * @event
214
215
  *
@@ -1693,30 +1694,55 @@ export declare class Client {
1693
1694
  */
1694
1695
  postVideoStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
1695
1696
  /**
1696
- * Consumes a list of id strings of statuses to delete.
1697
- * @param statusesToDelete string [] | stringan array of ids of statuses to delete.
1697
+ * {@license:restricted@}
1698
+ *
1699
+ * Consumes a list of id strings of stories to delete.
1700
+ *
1701
+ * @param statusesToDelete string [] | string an array of ids of stories to delete.
1698
1702
  * @returns boolean. True if it worked.
1699
1703
  */
1700
- deleteStatus(statusesToDelete: string | string[]): Promise<boolean>;
1704
+ deleteStory(statusesToDelete: string | string[]): Promise<boolean>;
1705
+ /**
1706
+ * @deprecated
1707
+ * Alias for deleteStory
1708
+ */
1709
+ deleteStatus: (statusesToDelete: string | string[]) => Promise<boolean>;
1701
1710
  /**
1702
- * Deletes all your existing statuses.
1711
+ * {@license:restricted@}
1712
+ *
1713
+ * Deletes all your existing stories.
1703
1714
  * @returns boolean. True if it worked.
1704
1715
  */
1705
- deleteAllStatus(): Promise<boolean>;
1716
+ deleteAllStories(): Promise<boolean>;
1717
+ /**
1718
+ * @deprecated
1719
+ * Alias for deleteStory
1720
+ */
1721
+ deleteAllStatus: () => Promise<boolean>;
1706
1722
  /**
1707
- * retrieves all existing statuses.
1723
+ * {@license:restricted@}
1724
+ *
1725
+ * Retrieves all existing stories.
1708
1726
  *
1709
1727
  * Only works with a Story License Key
1710
1728
  */
1711
- getMyStatusArray(): Promise<Message[]>;
1729
+ getMyStoryArray(): Promise<Message[]>;
1730
+ /**
1731
+ * @deprecated
1732
+ * Alias for deleteStory
1733
+ */
1734
+ getMyStatusArray: () => Promise<Message[]>;
1712
1735
  /**
1713
- * Retrieves an array of user ids that have 'read' your story.
1714
- *
1715
- * @param id string The id of the story
1716
- *
1717
- * Only works with a Story License Key
1718
- */
1719
- getStoryViewers(id: string): Promise<ContactId[]>;
1736
+ * {@license:restricted@}
1737
+ *
1738
+ * Retrieves an array of user ids that have 'read' your story.
1739
+ *
1740
+ * @param id string The id of the story
1741
+ *
1742
+ */
1743
+ getStoryViewers(id?: string): Promise<ContactId[] | {
1744
+ [k: MessageId]: ContactId[];
1745
+ }>;
1720
1746
  /**
1721
1747
  * Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots.
1722
1748
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-wa/wa-automate-types-only",
3
- "version": "4.48.0",
3
+ "version": "4.48.1",
4
4
  "description": "Types generated from the @open-wa/wa-automate package",
5
5
  "scripts": {
6
6
  "build": "tsc",