@wix/notifications 1.0.32 → 1.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/notifications",
3
- "version": "1.0.32",
3
+ "version": "1.0.34",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,8 +18,8 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/notifications_notifications": "1.0.18",
22
- "@wix/notifications_notifications-v-3": "1.0.2"
21
+ "@wix/notifications_notifications": "1.0.19",
22
+ "@wix/notifications_notifications-v-3": "1.0.3"
23
23
  },
24
24
  "devDependencies": {
25
25
  "glob": "^10.4.1",
@@ -44,5 +44,5 @@
44
44
  "fqdn": ""
45
45
  }
46
46
  },
47
- "falconPackageHash": "3042c82abcb6f5249a17c5eb48a30da64091eb3beeee6c8409e7eead"
47
+ "falconPackageHash": "315262aeabc05374ae4ecb1805444168e6269ecb0bcfdc1520421bda"
48
48
  }
@@ -33,105 +33,145 @@ declare global {
33
33
  }
34
34
 
35
35
  interface Public_notification {
36
- /** id */
36
+ /** Notification ID. */
37
37
  _id?: string | null;
38
38
  }
39
39
  interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
40
- /** Send to site contributors. This includes admins, managers, and assistants. */
40
+ /** List of site contributors to notify. */
41
41
  toSiteContributors?: ToSiteContributors;
42
- /** Send to contacts. */
42
+ /** List of contacts to notify. */
43
43
  toContacts?: ToContacts;
44
- /** Send to site members who subscrined to a particular topic. */
45
- toTopicsSubscribers?: ToTopicsSubscribers;
46
- /** an open url as an action target */
44
+ /** URL to navigate to when the `action` text is clicked. */
47
45
  targetUrl?: string | null;
48
- /** target_dashboard_page */
46
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
49
47
  targetDashboardPage?: DashboardPages;
50
- /** Notification title. */
48
+ /**
49
+ * Notification title. Only displayed on mobile and browser notifications.
50
+ *
51
+ * Max: 512 characters
52
+ */
51
53
  title?: string | null;
52
- /** Notification body. */
54
+ /**
55
+ * Contents of the notification.
56
+ *
57
+ * Max: 512 characters
58
+ */
53
59
  body?: string | null;
54
- /** The Action of the notification */
60
+ /**
61
+ * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
62
+ *
63
+ * Max: 512 characters
64
+ */
55
65
  action?: string | null;
56
- /** The channel to which send the notification */
66
+ /**
67
+ * The channels to send the notification on. One or more of:
68
+ *
69
+ * - `"Mobile"`: Sends the notification to the Wix App.
70
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
71
+ * - `"Browser"`: Sends the notification to the contributor's browser.
72
+ */
57
73
  channels?: Channel[];
58
74
  }
59
75
  /** @oneof */
60
76
  interface PublicNotifyRequestRecipientsFilterOneOf {
61
- /** Send to site contributors. This includes admins, managers, and assistants. */
77
+ /** List of site contributors to notify. */
62
78
  toSiteContributors?: ToSiteContributors;
63
- /** Send to contacts. */
79
+ /** List of contacts to notify. */
64
80
  toContacts?: ToContacts;
65
- /** Send to site members who subscrined to a particular topic. */
66
- toTopicsSubscribers?: ToTopicsSubscribers;
67
81
  }
68
82
  /** @oneof */
69
83
  interface PublicNotifyRequestActionTargetOneOf {
70
- /** an open url as an action target */
84
+ /** URL to navigate to when the `action` text is clicked. */
71
85
  targetUrl?: string | null;
72
- /** target_dashboard_page */
86
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
73
87
  targetDashboardPage?: DashboardPages;
74
88
  }
75
89
  interface ToSiteContributors {
76
- /** with_role */
90
+ /**
91
+ * Roles to receive the notification. One of:
92
+ *
93
+ * - `"All_Contributors"`: All site contributors (default).
94
+ * - `"Owner"`: Only the site owner.
95
+ */
77
96
  withRole?: Role;
78
97
  }
79
98
  declare enum Role {
80
- /** All contributors with any role */
99
+ /** All site contributors. */
81
100
  All_Contributors = "All_Contributors",
82
- /** Only the owner */
101
+ /** Site owner only. */
83
102
  Owner = "Owner"
84
103
  }
85
104
  interface ToContacts {
86
- /** contact_ids */
105
+ /** List of contact IDs. */
87
106
  contactIds?: string[];
88
107
  }
89
108
  interface ToTopicsSubscribers {
90
- /** topics */
109
+ /** List of topics. */
91
110
  topics?: string[];
92
- /** excluded_contact_ids */
111
+ /** List of contact IDs to exclude from notification. */
93
112
  excludedContactIds?: string[];
94
113
  }
95
114
  declare enum Channel {
96
- /** No Default Channel - need to expilicitly decide on channel */
115
+ /** No default channel. */
97
116
  Undefined = "Undefined",
98
- /** The widget inside Wix */
117
+ /** Site dashboard. */
99
118
  Dashboard = "Dashboard",
100
- /** Mobile push to WixApp */
119
+ /** [Wix Owner](https://www.wix.com/mobile/wix-app) mobile app. */
101
120
  Mobile = "Mobile",
102
- /** Browser push to the active browser (Chrome/Safari only) */
121
+ /** Active browser. Supported on Chrome and Safari only. */
103
122
  Browser = "Browser"
104
123
  }
105
124
  declare enum DashboardPages {
106
125
  Undefined_Page = "Undefined_Page",
107
- /** goes to business manager home */
126
+ /** Site dashboard home. */
108
127
  Home = "Home"
109
128
  }
110
129
  interface Empty {
111
130
  }
112
131
  interface NotifyOptions$1 extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
113
- /** Send to site contributors. This includes admins, managers, and assistants. */
132
+ /** List of site contributors to notify. */
114
133
  toSiteContributors?: ToSiteContributors;
115
- /** Send to contacts. */
134
+ /** List of contacts to notify. */
116
135
  toContacts?: ToContacts;
117
- /** Send to site members who subscrined to a particular topic. */
118
- toTopicsSubscribers?: ToTopicsSubscribers;
119
- /** Notification title. */
136
+ /**
137
+ * Notification title. Only displayed on mobile and browser notifications.
138
+ *
139
+ * Max: 512 characters
140
+ */
120
141
  title?: string | null;
121
- /** The Action of the notification */
142
+ /**
143
+ * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
144
+ *
145
+ * Max: 512 characters
146
+ */
122
147
  action?: string | null;
123
- /** an open url as an action target */
148
+ /** URL to navigate to when the `action` text is clicked. */
124
149
  targetUrl?: string | null;
125
- /** target_dashboard_page */
150
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
126
151
  targetDashboardPage?: DashboardPages;
127
152
  }
128
153
 
129
154
  declare function notify$3(httpClient: HttpClient): NotifySignature$1;
130
155
  interface NotifySignature$1 {
131
156
  /**
132
- * Sends notifications to recipients.
133
- * @param - Notification body.
134
- * @param - The channel to which send the notification
157
+ * Sends a notification.
158
+ *
159
+ *
160
+ * The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.
161
+ *
162
+ * List the the channels for the notification in the `channels` parameter .
163
+ *
164
+ * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
165
+ * @param - Notification options.
166
+ * @param - The body of the notification.
167
+ *
168
+ * Max: 512 characters
169
+ * @param - The channels to send the notification on. One or more of:
170
+ *
171
+ * - `"Mobile"`: Sends the notification to the Wix App.
172
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
173
+ * - `"Browser"`: Sends the notification to the contributor's browser.
174
+ * @returns Fulfilled when the send notification request is received.
135
175
  */
136
176
  (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;
137
177
  }
@@ -163,7 +203,7 @@ interface Notification {
163
203
  interface NotifyRequest {
164
204
  /**
165
205
  * Notification template ID. A notification template specifies the text and recipients for notifications.
166
- * To obtain a notification template ID, create a notification template in the Wix Dev Center.
206
+ * To obtain a notification template ID, create a notification template in your app's dashboard.
167
207
  */
168
208
  notificationTemplateId: string;
169
209
  /**
@@ -297,12 +337,12 @@ interface NotifySignature {
297
337
  *
298
338
  * An app can call this endpoint up to 100,000 times per month for each site.
299
339
  *
300
- * When you create a notification template in the Wix Dev Center, you are given a notification template ID.
340
+ * When you create a notification template in the app dashboard, you are given a notification template ID.
301
341
  * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.
302
342
  * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.
303
343
  * The values you specify are incorporated seamlessly in the notifications sent out.
304
344
  * @param - Notification template ID. A notification template specifies the text and recipients for notifications.
305
- * To obtain a notification template ID, create a notification template in the Wix Dev Center.
345
+ * To obtain a notification template ID, create a notification template in your app's dashboard.
306
346
  */
307
347
  (notificationTemplateId: string, options?: NotifyOptions | undefined): Promise<NotifyResponse & NotifyResponseNonNullableFields>;
308
348
  }
@@ -33,105 +33,145 @@ declare global {
33
33
  }
34
34
 
35
35
  interface Public_notification {
36
- /** id */
36
+ /** Notification ID. */
37
37
  _id?: string | null;
38
38
  }
39
39
  interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
40
- /** Send to site contributors. This includes admins, managers, and assistants. */
40
+ /** List of site contributors to notify. */
41
41
  toSiteContributors?: ToSiteContributors;
42
- /** Send to contacts. */
42
+ /** List of contacts to notify. */
43
43
  toContacts?: ToContacts;
44
- /** Send to site members who subscrined to a particular topic. */
45
- toTopicsSubscribers?: ToTopicsSubscribers;
46
- /** an open url as an action target */
44
+ /** URL to navigate to when the `action` text is clicked. */
47
45
  targetUrl?: string | null;
48
- /** target_dashboard_page */
46
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
49
47
  targetDashboardPage?: DashboardPages;
50
- /** Notification title. */
48
+ /**
49
+ * Notification title. Only displayed on mobile and browser notifications.
50
+ *
51
+ * Max: 512 characters
52
+ */
51
53
  title?: string | null;
52
- /** Notification body. */
54
+ /**
55
+ * Contents of the notification.
56
+ *
57
+ * Max: 512 characters
58
+ */
53
59
  body?: string | null;
54
- /** The Action of the notification */
60
+ /**
61
+ * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
62
+ *
63
+ * Max: 512 characters
64
+ */
55
65
  action?: string | null;
56
- /** The channel to which send the notification */
66
+ /**
67
+ * The channels to send the notification on. One or more of:
68
+ *
69
+ * - `"Mobile"`: Sends the notification to the Wix App.
70
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
71
+ * - `"Browser"`: Sends the notification to the contributor's browser.
72
+ */
57
73
  channels?: Channel[];
58
74
  }
59
75
  /** @oneof */
60
76
  interface PublicNotifyRequestRecipientsFilterOneOf {
61
- /** Send to site contributors. This includes admins, managers, and assistants. */
77
+ /** List of site contributors to notify. */
62
78
  toSiteContributors?: ToSiteContributors;
63
- /** Send to contacts. */
79
+ /** List of contacts to notify. */
64
80
  toContacts?: ToContacts;
65
- /** Send to site members who subscrined to a particular topic. */
66
- toTopicsSubscribers?: ToTopicsSubscribers;
67
81
  }
68
82
  /** @oneof */
69
83
  interface PublicNotifyRequestActionTargetOneOf {
70
- /** an open url as an action target */
84
+ /** URL to navigate to when the `action` text is clicked. */
71
85
  targetUrl?: string | null;
72
- /** target_dashboard_page */
86
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
73
87
  targetDashboardPage?: DashboardPages;
74
88
  }
75
89
  interface ToSiteContributors {
76
- /** with_role */
90
+ /**
91
+ * Roles to receive the notification. One of:
92
+ *
93
+ * - `"All_Contributors"`: All site contributors (default).
94
+ * - `"Owner"`: Only the site owner.
95
+ */
77
96
  withRole?: Role;
78
97
  }
79
98
  declare enum Role {
80
- /** All contributors with any role */
99
+ /** All site contributors. */
81
100
  All_Contributors = "All_Contributors",
82
- /** Only the owner */
101
+ /** Site owner only. */
83
102
  Owner = "Owner"
84
103
  }
85
104
  interface ToContacts {
86
- /** contact_ids */
105
+ /** List of contact IDs. */
87
106
  contactIds?: string[];
88
107
  }
89
108
  interface ToTopicsSubscribers {
90
- /** topics */
109
+ /** List of topics. */
91
110
  topics?: string[];
92
- /** excluded_contact_ids */
111
+ /** List of contact IDs to exclude from notification. */
93
112
  excludedContactIds?: string[];
94
113
  }
95
114
  declare enum Channel {
96
- /** No Default Channel - need to expilicitly decide on channel */
115
+ /** No default channel. */
97
116
  Undefined = "Undefined",
98
- /** The widget inside Wix */
117
+ /** Site dashboard. */
99
118
  Dashboard = "Dashboard",
100
- /** Mobile push to WixApp */
119
+ /** [Wix Owner](https://www.wix.com/mobile/wix-app) mobile app. */
101
120
  Mobile = "Mobile",
102
- /** Browser push to the active browser (Chrome/Safari only) */
121
+ /** Active browser. Supported on Chrome and Safari only. */
103
122
  Browser = "Browser"
104
123
  }
105
124
  declare enum DashboardPages {
106
125
  Undefined_Page = "Undefined_Page",
107
- /** goes to business manager home */
126
+ /** Site dashboard home. */
108
127
  Home = "Home"
109
128
  }
110
129
  interface Empty {
111
130
  }
112
131
  interface NotifyOptions$1 extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
113
- /** Send to site contributors. This includes admins, managers, and assistants. */
132
+ /** List of site contributors to notify. */
114
133
  toSiteContributors?: ToSiteContributors;
115
- /** Send to contacts. */
134
+ /** List of contacts to notify. */
116
135
  toContacts?: ToContacts;
117
- /** Send to site members who subscrined to a particular topic. */
118
- toTopicsSubscribers?: ToTopicsSubscribers;
119
- /** Notification title. */
136
+ /**
137
+ * Notification title. Only displayed on mobile and browser notifications.
138
+ *
139
+ * Max: 512 characters
140
+ */
120
141
  title?: string | null;
121
- /** The Action of the notification */
142
+ /**
143
+ * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
144
+ *
145
+ * Max: 512 characters
146
+ */
122
147
  action?: string | null;
123
- /** an open url as an action target */
148
+ /** URL to navigate to when the `action` text is clicked. */
124
149
  targetUrl?: string | null;
125
- /** target_dashboard_page */
150
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
126
151
  targetDashboardPage?: DashboardPages;
127
152
  }
128
153
 
129
154
  declare function notify$3(httpClient: HttpClient): NotifySignature$1;
130
155
  interface NotifySignature$1 {
131
156
  /**
132
- * Sends notifications to recipients.
133
- * @param - Notification body.
134
- * @param - The channel to which send the notification
157
+ * Sends a notification.
158
+ *
159
+ *
160
+ * The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.
161
+ *
162
+ * List the the channels for the notification in the `channels` parameter .
163
+ *
164
+ * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
165
+ * @param - Notification options.
166
+ * @param - The body of the notification.
167
+ *
168
+ * Max: 512 characters
169
+ * @param - The channels to send the notification on. One or more of:
170
+ *
171
+ * - `"Mobile"`: Sends the notification to the Wix App.
172
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
173
+ * - `"Browser"`: Sends the notification to the contributor's browser.
174
+ * @returns Fulfilled when the send notification request is received.
135
175
  */
136
176
  (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;
137
177
  }
@@ -163,7 +203,7 @@ interface Notification {
163
203
  interface NotifyRequest {
164
204
  /**
165
205
  * Notification template ID. A notification template specifies the text and recipients for notifications.
166
- * To obtain a notification template ID, create a notification template in the Wix Dev Center.
206
+ * To obtain a notification template ID, create a notification template in your app's dashboard.
167
207
  */
168
208
  notificationTemplateId: string;
169
209
  /**
@@ -297,12 +337,12 @@ interface NotifySignature {
297
337
  *
298
338
  * An app can call this endpoint up to 100,000 times per month for each site.
299
339
  *
300
- * When you create a notification template in the Wix Dev Center, you are given a notification template ID.
340
+ * When you create a notification template in the app dashboard, you are given a notification template ID.
301
341
  * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.
302
342
  * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.
303
343
  * The values you specify are incorporated seamlessly in the notifications sent out.
304
344
  * @param - Notification template ID. A notification template specifies the text and recipients for notifications.
305
- * To obtain a notification template ID, create a notification template in the Wix Dev Center.
345
+ * To obtain a notification template ID, create a notification template in your app's dashboard.
306
346
  */
307
347
  (notificationTemplateId: string, options?: NotifyOptions | undefined): Promise<NotifyResponse & NotifyResponseNonNullableFields>;
308
348
  }
@@ -1,146 +1,149 @@
1
1
  interface PublicNotifyRequest$1 extends PublicNotifyRequestRecipientsFilterOneOf$1, PublicNotifyRequestActionTargetOneOf$1 {
2
- /** Send to site contributors. This includes admins, managers, and assistants. */
2
+ /** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
3
3
  toSiteContributors?: ToSiteContributors$1;
4
- /** Send to contacts. */
4
+ /** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
5
5
  toContacts?: ToContacts$1;
6
- /** Send to site members who subscrined to a particular topic. */
7
- toTopicsSubscribers?: ToTopicsSubscribers$1;
8
- /** an open url as an action target */
6
+ /** External URL to open when the notification action is clicked. */
9
7
  targetUrl?: string | null;
10
- /** target_dashboard_page */
8
+ /** Dashboard page to open when the notification action is clicked. */
11
9
  targetDashboardPage?: DashboardPages$1;
12
- /** Notification title. */
10
+ /** Title of the notification. */
13
11
  title?: string | null;
14
- /** Notification body. */
12
+ /** Body of the notification. This contains the main content of the notification. */
15
13
  body?: string | null;
16
- /** The Action of the notification */
14
+ /** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
17
15
  action?: string | null;
18
- /** The channel to which send the notification */
16
+ /** Channel through which users receive the notification. */
19
17
  channels?: Channel$1[];
20
18
  }
21
19
  /** @oneof */
22
20
  interface PublicNotifyRequestRecipientsFilterOneOf$1 {
23
- /** Send to site contributors. This includes admins, managers, and assistants. */
21
+ /** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
24
22
  toSiteContributors?: ToSiteContributors$1;
25
- /** Send to contacts. */
23
+ /** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
26
24
  toContacts?: ToContacts$1;
27
- /** Send to site members who subscrined to a particular topic. */
28
- toTopicsSubscribers?: ToTopicsSubscribers$1;
29
25
  }
30
26
  /** @oneof */
31
27
  interface PublicNotifyRequestActionTargetOneOf$1 {
32
- /** an open url as an action target */
28
+ /** External URL to open when the notification action is clicked. */
33
29
  targetUrl?: string | null;
34
- /** target_dashboard_page */
30
+ /** Dashboard page to open when the notification action is clicked. */
35
31
  targetDashboardPage?: DashboardPages$1;
36
32
  }
37
33
  interface ToSiteContributors$1 {
38
- /** with_role */
34
+ /** Role assigned to site contributors. Only contributors with the specified roles receive the notification. */
39
35
  withRole?: Role$1;
40
36
  }
41
37
  declare enum Role$1 {
42
- /** All contributors with any role */
38
+ /** All site contributors. */
43
39
  All_Contributors = "All_Contributors",
44
- /** Only the owner */
40
+ /** Site owner only. */
45
41
  Owner = "Owner"
46
42
  }
47
43
  interface ToContacts$1 {
48
- /** contact_ids */
44
+ /** Contacts that receive the notification. */
49
45
  contactIds?: string[];
50
46
  }
51
- interface ToTopicsSubscribers$1 {
52
- /** topics */
53
- topics?: string[];
54
- /** excluded_contact_ids */
55
- excludedContactIds?: string[];
56
- }
57
47
  declare enum Channel$1 {
58
- /** No Default Channel - need to expilicitly decide on channel */
48
+ /** No default channel. */
59
49
  Undefined = "Undefined",
60
- /** The widget inside Wix */
50
+ /** Site dashboard. */
61
51
  Dashboard = "Dashboard",
62
- /** Mobile push to WixApp */
52
+ /** [Wix Owner](https://www.wix.com/mobile/wix-app) mobile app. */
63
53
  Mobile = "Mobile",
64
- /** Browser push to the active browser (Chrome/Safari only) */
54
+ /** Active browser. Supported on Chrome and Safari only. */
65
55
  Browser = "Browser"
66
56
  }
67
57
  declare enum DashboardPages$1 {
68
58
  Undefined_Page = "Undefined_Page",
69
- /** goes to business manager home */
59
+ /** Site dashboard home. */
70
60
  Home = "Home"
71
61
  }
72
62
  interface Empty$1 {
73
63
  }
74
64
 
75
65
  interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
76
- /** Send to site contributors. This includes admins, managers, and assistants. */
66
+ /** List of site contributors to notify. */
77
67
  toSiteContributors?: ToSiteContributors;
78
- /** Send to contacts. */
68
+ /** List of contacts to notify. */
79
69
  toContacts?: ToContacts;
80
- /** Send to site members who subscrined to a particular topic. */
81
- toTopicsSubscribers?: ToTopicsSubscribers;
82
- /** an open url as an action target */
70
+ /** URL to navigate to when the `action` text is clicked. */
83
71
  targetUrl?: string | null;
84
- /** target_dashboard_page */
72
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
85
73
  targetDashboardPage?: DashboardPages;
86
- /** Notification title. */
74
+ /**
75
+ * Notification title. Only displayed on mobile and browser notifications.
76
+ *
77
+ * Max: 512 characters
78
+ */
87
79
  title?: string | null;
88
- /** Notification body. */
80
+ /**
81
+ * Contents of the notification.
82
+ *
83
+ * Max: 512 characters
84
+ */
89
85
  body?: string | null;
90
- /** The Action of the notification */
86
+ /**
87
+ * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
88
+ *
89
+ * Max: 512 characters
90
+ */
91
91
  action?: string | null;
92
- /** The channel to which send the notification */
92
+ /**
93
+ * The channels to send the notification on. One or more of:
94
+ *
95
+ * - `"Mobile"`: Sends the notification to the Wix App.
96
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
97
+ * - `"Browser"`: Sends the notification to the contributor's browser.
98
+ */
93
99
  channels?: Channel[];
94
100
  }
95
101
  /** @oneof */
96
102
  interface PublicNotifyRequestRecipientsFilterOneOf {
97
- /** Send to site contributors. This includes admins, managers, and assistants. */
103
+ /** List of site contributors to notify. */
98
104
  toSiteContributors?: ToSiteContributors;
99
- /** Send to contacts. */
105
+ /** List of contacts to notify. */
100
106
  toContacts?: ToContacts;
101
- /** Send to site members who subscrined to a particular topic. */
102
- toTopicsSubscribers?: ToTopicsSubscribers;
103
107
  }
104
108
  /** @oneof */
105
109
  interface PublicNotifyRequestActionTargetOneOf {
106
- /** an open url as an action target */
110
+ /** URL to navigate to when the `action` text is clicked. */
107
111
  targetUrl?: string | null;
108
- /** target_dashboard_page */
112
+ /** URL of Dashboard page to navigate to when the `action` text is clicked. */
109
113
  targetDashboardPage?: DashboardPages;
110
114
  }
111
115
  interface ToSiteContributors {
112
- /** with_role */
116
+ /**
117
+ * Roles to receive the notification. One of:
118
+ *
119
+ * - `"All_Contributors"`: All site contributors (default).
120
+ * - `"Owner"`: Only the site owner.
121
+ */
113
122
  withRole?: Role;
114
123
  }
115
124
  declare enum Role {
116
- /** All contributors with any role */
125
+ /** All site contributors. */
117
126
  All_Contributors = "All_Contributors",
118
- /** Only the owner */
127
+ /** Site owner only. */
119
128
  Owner = "Owner"
120
129
  }
121
130
  interface ToContacts {
122
- /** contact_ids */
131
+ /** List of contact IDs. */
123
132
  contactIds?: string[];
124
133
  }
125
- interface ToTopicsSubscribers {
126
- /** topics */
127
- topics?: string[];
128
- /** excluded_contact_ids */
129
- excludedContactIds?: string[];
130
- }
131
134
  declare enum Channel {
132
- /** No Default Channel - need to expilicitly decide on channel */
135
+ /** No default channel. */
133
136
  Undefined = "Undefined",
134
- /** The widget inside Wix */
137
+ /** Site dashboard. */
135
138
  Dashboard = "Dashboard",
136
- /** Mobile push to WixApp */
139
+ /** [Wix Owner](https://www.wix.com/mobile/wix-app) mobile app. */
137
140
  Mobile = "Mobile",
138
- /** Browser push to the active browser (Chrome/Safari only) */
141
+ /** Active browser. Supported on Chrome and Safari only. */
139
142
  Browser = "Browser"
140
143
  }
141
144
  declare enum DashboardPages {
142
145
  Undefined_Page = "Undefined_Page",
143
- /** goes to business manager home */
146
+ /** Site dashboard home. */
144
147
  Home = "Home"
145
148
  }
146
149
  interface Empty {
@@ -165,7 +168,7 @@ declare namespace meta$1 {
165
168
  interface NotifyRequest$1 {
166
169
  /**
167
170
  * Notification template ID. A notification template specifies the text and recipients for notifications.
168
- * To obtain a notification template ID, create a notification template in the Wix Dev Center.
171
+ * To obtain a notification template ID, create a notification template in your app's dashboard.
169
172
  */
170
173
  notificationTemplateId: string;
171
174
  /**
@@ -194,7 +197,7 @@ interface NotifyResponseNonNullableFields$1 {
194
197
  interface NotifyRequest {
195
198
  /**
196
199
  * Notification template ID. A notification template specifies the text and recipients for notifications.
197
- * To obtain a notification template ID, create a notification template in the Wix Dev Center.
200
+ * To obtain a notification template ID, create a notification template in your app's dashboard.
198
201
  */
199
202
  notificationTemplateId: string;
200
203
  /**