@wix/notifications 1.0.36 → 1.0.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/notifications",
-  "version": "1.0.36",
+  "version": "1.0.37",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/notifications_notifications": "1.0.21",
+    "@wix/notifications_notifications": "1.0.22",
     "@wix/notifications_notifications-v-3": "1.0.5"
   },
   "devDependencies": {
@@ -44,5 +44,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "f97486a3f7ba50b7db50da996139a33fd6c7f959013da8f970c644a2"
+  "falconPackageHash": "afc21544e8dd18a5efa66f0f24020ccfe194b3589c3b09ff2a7fb511"
 }

package/type-bundles/context.bundle.d.ts

@@ -413,38 +413,28 @@ interface Public_notification {
     _id?: string | null;
 }
 interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
-    /** List of site contributors to notify. */
+    /** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
     toSiteContributors?: ToSiteContributors;
-    /** List of contacts to notify. */
+    /** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
     toContacts?: ToContacts;
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Contents of the notification.
-     *
+     * Body of the notification. This contains the main content of the notification.
      * Max: 512 characters
      */
     body?: string | null;
-    /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
     action?: string | null;
     /**
-     * The channels to send the notification on. One or more of:
-     *
+     * Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      */
     channels?: Channel[];
 }
@@ -459,15 +449,14 @@ interface PublicNotifyRequestRecipientsFilterOneOf {
 interface PublicNotifyRequestActionTargetOneOf {
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 interface ToSiteContributors {
     /**
-     * Roles to receive the notification. One of:
-     *
-     * - `"All_Contributors"`: All site contributors (default).
-     * - `"Owner"`: Only the site owner.
+     * Role assigned to site contributors. Only contributors with the specified roles receive the notification:
+     * - `"All_Contributors"`: All site collaborators (default).
+     * - `"Owner"`: Site owner only.
      */
     withRole?: Role;
 }
@@ -478,13 +467,13 @@ declare enum Role {
     Owner = "Owner"
 }
 interface ToContacts {
-    /** List of contact IDs. */
+    /** Contacts that receive the notification.  */
     contactIds?: string[];
 }
 interface ToTopicsSubscribers {
-    /** List of topics. */
+    /** Notification topics to which the recipients have subscribed. Only contacts who subscribed to the specified topics receive the notification. */
     topics?: string[];
-    /** List of contact IDs to exclude from notification. */
+    /** Excluded contact IDs. Contacts with these IDs don't receive the notification. */
     excludedContactIds?: string[];
 }
 declare enum Channel {
@@ -509,21 +498,17 @@ interface NotifyOptions$1 extends PublicNotifyRequestRecipientsFilterOneOf, Publ
     toSiteContributors?: ToSiteContributors;
     /** List of contacts to notify. */
     toContacts?: ToContacts;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
+     *  Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page.
      *
-     * Max: 512 characters
+     * Max: 512 characters.
      */
     action?: string | null;
-    /** URL to navigate to when the `action` text is clicked. */
+    /** External URL to open when the notification action is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 
@@ -539,14 +524,11 @@ interface NotifySignature$1 {
      *
      * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
      * @param - Notification options.
-     * @param - The body of the notification.
-     *
-     * Max: 512 characters
-     * @param - The channels to send the notification on. One or more of:
-     *
+     * @param - Body of the notification. This contains the main content of the notification.
+     * @param - Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      * @returns Fulfilled when the send notification request is received.
      */
     (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;

package/type-bundles/index.bundle.d.ts

@@ -413,38 +413,28 @@ interface Public_notification {
     _id?: string | null;
 }
 interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
-    /** List of site contributors to notify. */
+    /** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
     toSiteContributors?: ToSiteContributors;
-    /** List of contacts to notify. */
+    /** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
     toContacts?: ToContacts;
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Contents of the notification.
-     *
+     * Body of the notification. This contains the main content of the notification.
      * Max: 512 characters
      */
     body?: string | null;
-    /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
     action?: string | null;
     /**
-     * The channels to send the notification on. One or more of:
-     *
+     * Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      */
     channels?: Channel[];
 }
@@ -459,15 +449,14 @@ interface PublicNotifyRequestRecipientsFilterOneOf {
 interface PublicNotifyRequestActionTargetOneOf {
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 interface ToSiteContributors {
     /**
-     * Roles to receive the notification. One of:
-     *
-     * - `"All_Contributors"`: All site contributors (default).
-     * - `"Owner"`: Only the site owner.
+     * Role assigned to site contributors. Only contributors with the specified roles receive the notification:
+     * - `"All_Contributors"`: All site collaborators (default).
+     * - `"Owner"`: Site owner only.
      */
     withRole?: Role;
 }
@@ -478,13 +467,13 @@ declare enum Role {
     Owner = "Owner"
 }
 interface ToContacts {
-    /** List of contact IDs. */
+    /** Contacts that receive the notification.  */
     contactIds?: string[];
 }
 interface ToTopicsSubscribers {
-    /** List of topics. */
+    /** Notification topics to which the recipients have subscribed. Only contacts who subscribed to the specified topics receive the notification. */
     topics?: string[];
-    /** List of contact IDs to exclude from notification. */
+    /** Excluded contact IDs. Contacts with these IDs don't receive the notification. */
     excludedContactIds?: string[];
 }
 declare enum Channel {
@@ -509,21 +498,17 @@ interface NotifyOptions$1 extends PublicNotifyRequestRecipientsFilterOneOf, Publ
     toSiteContributors?: ToSiteContributors;
     /** List of contacts to notify. */
     toContacts?: ToContacts;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
+     *  Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page.
      *
-     * Max: 512 characters
+     * Max: 512 characters.
      */
     action?: string | null;
-    /** URL to navigate to when the `action` text is clicked. */
+    /** External URL to open when the notification action is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 
@@ -539,14 +524,11 @@ interface NotifySignature$1 {
      *
      * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
      * @param - Notification options.
-     * @param - The body of the notification.
-     *
-     * Max: 512 characters
-     * @param - The channels to send the notification on. One or more of:
-     *
+     * @param - Body of the notification. This contains the main content of the notification.
+     * @param - Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      * @returns Fulfilled when the send notification request is received.
      */
     (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;

package/type-bundles/meta.bundle.d.ts

@@ -63,38 +63,28 @@ interface Empty$1 {
 }
 
 interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
-    /** List of site contributors to notify. */
+    /** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
     toSiteContributors?: ToSiteContributors;
-    /** List of contacts to notify. */
+    /** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
     toContacts?: ToContacts;
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Contents of the notification.
-     *
+     * Body of the notification. This contains the main content of the notification.
      * Max: 512 characters
      */
     body?: string | null;
-    /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
     action?: string | null;
     /**
-     * The channels to send the notification on. One or more of:
-     *
+     * Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      */
     channels?: Channel[];
 }
@@ -109,15 +99,14 @@ interface PublicNotifyRequestRecipientsFilterOneOf {
 interface PublicNotifyRequestActionTargetOneOf {
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 interface ToSiteContributors {
     /**
-     * Roles to receive the notification. One of:
-     *
-     * - `"All_Contributors"`: All site contributors (default).
-     * - `"Owner"`: Only the site owner.
+     * Role assigned to site contributors. Only contributors with the specified roles receive the notification:
+     * - `"All_Contributors"`: All site collaborators (default).
+     * - `"Owner"`: Site owner only.
      */
     withRole?: Role;
 }
@@ -128,7 +117,7 @@ declare enum Role {
     Owner = "Owner"
 }
 interface ToContacts {
-    /** List of contact IDs. */
+    /** Contacts that receive the notification.  */
     contactIds?: string[];
 }
 declare enum Channel {