@wix/notifications 1.0.36 → 1.0.38
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 +3 -3
- package/type-bundles/context.bundle.d.ts +82 -510
- package/type-bundles/index.bundle.d.ts +82 -510
- package/type-bundles/meta.bundle.d.ts +14 -25
|
@@ -63,38 +63,28 @@ interface Empty$1 {
|
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
66
|
-
/**
|
|
66
|
+
/** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
|
|
67
67
|
toSiteContributors?: ToSiteContributors;
|
|
68
|
-
/**
|
|
68
|
+
/** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
|
|
69
69
|
toContacts?: ToContacts;
|
|
70
70
|
/** URL to navigate to when the `action` text is clicked. */
|
|
71
71
|
targetUrl?: string | null;
|
|
72
|
-
/**
|
|
72
|
+
/** Dashboard page to open when the notification action is clicked. */
|
|
73
73
|
targetDashboardPage?: DashboardPages;
|
|
74
|
-
/**
|
|
75
|
-
* Notification title. Only displayed on mobile and browser notifications.
|
|
76
|
-
*
|
|
77
|
-
* Max: 512 characters
|
|
78
|
-
*/
|
|
74
|
+
/** Title of the notification. Max: 512 characters. */
|
|
79
75
|
title?: string | null;
|
|
80
76
|
/**
|
|
81
|
-
*
|
|
82
|
-
*
|
|
77
|
+
* Body of the notification. This contains the main content of the notification.
|
|
83
78
|
* Max: 512 characters
|
|
84
79
|
*/
|
|
85
80
|
body?: string | null;
|
|
86
|
-
/**
|
|
87
|
-
* Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
|
|
88
|
-
*
|
|
89
|
-
* Max: 512 characters
|
|
90
|
-
*/
|
|
81
|
+
/** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
|
|
91
82
|
action?: string | null;
|
|
92
83
|
/**
|
|
93
|
-
*
|
|
94
|
-
*
|
|
84
|
+
* Channel through which users receive the notification.
|
|
95
85
|
* - `"Mobile"`: Sends the notification to the Wix App.
|
|
96
|
-
* - `"Dashboard"`: Sends the notification to the
|
|
97
|
-
* - `"Browser"`: Sends the notification to the
|
|
86
|
+
* - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
|
|
87
|
+
* - `"Browser"`: Sends the notification to the collaborator's browser.
|
|
98
88
|
*/
|
|
99
89
|
channels?: Channel[];
|
|
100
90
|
}
|
|
@@ -109,15 +99,14 @@ interface PublicNotifyRequestRecipientsFilterOneOf {
|
|
|
109
99
|
interface PublicNotifyRequestActionTargetOneOf {
|
|
110
100
|
/** URL to navigate to when the `action` text is clicked. */
|
|
111
101
|
targetUrl?: string | null;
|
|
112
|
-
/**
|
|
102
|
+
/** Dashboard page to open when the notification action is clicked. */
|
|
113
103
|
targetDashboardPage?: DashboardPages;
|
|
114
104
|
}
|
|
115
105
|
interface ToSiteContributors {
|
|
116
106
|
/**
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* - `"
|
|
120
|
-
* - `"Owner"`: Only the site owner.
|
|
107
|
+
* Role assigned to site contributors. Only contributors with the specified roles receive the notification:
|
|
108
|
+
* - `"All_Contributors"`: All site collaborators (default).
|
|
109
|
+
* - `"Owner"`: Site owner only.
|
|
121
110
|
*/
|
|
122
111
|
withRole?: Role;
|
|
123
112
|
}
|
|
@@ -128,7 +117,7 @@ declare enum Role {
|
|
|
128
117
|
Owner = "Owner"
|
|
129
118
|
}
|
|
130
119
|
interface ToContacts {
|
|
131
|
-
/**
|
|
120
|
+
/** Contacts that receive the notification. */
|
|
132
121
|
contactIds?: string[];
|
|
133
122
|
}
|
|
134
123
|
declare enum Channel {
|