@wix/notifications 1.0.47 → 1.0.48
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/build/es/package.json +3 -0
- package/meta/package.json +1 -5
- package/package.json +20 -17
- package/build/cjs/context.d.ts +0 -2
- package/build/cjs/context.js +0 -29
- package/build/cjs/context.js.map +0 -1
- package/build/es/context.d.ts +0 -2
- package/build/es/context.js +0 -3
- package/build/es/context.js.map +0 -1
- package/context/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -803
- package/type-bundles/index.bundle.d.ts +0 -803
- package/type-bundles/meta.bundle.d.ts +0 -233
|
@@ -1,233 +0,0 @@
|
|
|
1
|
-
interface PublicNotifyRequest$1 extends PublicNotifyRequestRecipientsFilterOneOf$1, PublicNotifyRequestActionTargetOneOf$1 {
|
|
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
|
-
toSiteContributors?: ToSiteContributors$1;
|
|
4
|
-
/** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
|
|
5
|
-
toContacts?: ToContacts$1;
|
|
6
|
-
/** External URL to open when the notification action is clicked. */
|
|
7
|
-
targetUrl?: string | null;
|
|
8
|
-
/** Dashboard page to open when the notification action is clicked. */
|
|
9
|
-
targetDashboardPage?: DashboardPages$1;
|
|
10
|
-
/** Title of the notification. */
|
|
11
|
-
title?: string | null;
|
|
12
|
-
/** Body of the notification. This contains the main content of the notification. */
|
|
13
|
-
body?: string | null;
|
|
14
|
-
/** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
|
|
15
|
-
action?: string | null;
|
|
16
|
-
/** Channel through which users receive the notification. */
|
|
17
|
-
channels?: Channel$1[];
|
|
18
|
-
}
|
|
19
|
-
/** @oneof */
|
|
20
|
-
interface PublicNotifyRequestRecipientsFilterOneOf$1 {
|
|
21
|
-
/** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
|
|
22
|
-
toSiteContributors?: ToSiteContributors$1;
|
|
23
|
-
/** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
|
|
24
|
-
toContacts?: ToContacts$1;
|
|
25
|
-
}
|
|
26
|
-
/** @oneof */
|
|
27
|
-
interface PublicNotifyRequestActionTargetOneOf$1 {
|
|
28
|
-
/** External URL to open when the notification action is clicked. */
|
|
29
|
-
targetUrl?: string | null;
|
|
30
|
-
/** Dashboard page to open when the notification action is clicked. */
|
|
31
|
-
targetDashboardPage?: DashboardPages$1;
|
|
32
|
-
}
|
|
33
|
-
interface ToSiteContributors$1 {
|
|
34
|
-
/** Role assigned to site contributors. Only contributors with the specified roles receive the notification. */
|
|
35
|
-
withRole?: Role$1;
|
|
36
|
-
}
|
|
37
|
-
declare enum Role$1 {
|
|
38
|
-
/** All site contributors. */
|
|
39
|
-
All_Contributors = "All_Contributors",
|
|
40
|
-
/** Site owner only. */
|
|
41
|
-
Owner = "Owner"
|
|
42
|
-
}
|
|
43
|
-
interface ToContacts$1 {
|
|
44
|
-
/** Contacts that receive the notification. */
|
|
45
|
-
contactIds?: string[];
|
|
46
|
-
}
|
|
47
|
-
declare enum Channel$1 {
|
|
48
|
-
/** No default channel. */
|
|
49
|
-
Undefined = "Undefined",
|
|
50
|
-
/** Site dashboard. */
|
|
51
|
-
Dashboard = "Dashboard",
|
|
52
|
-
/** [Wix Owner](https://www.wix.com/mobile/wix-app) mobile app. */
|
|
53
|
-
Mobile = "Mobile",
|
|
54
|
-
/** Active browser. Supported on Chrome and Safari only. */
|
|
55
|
-
Browser = "Browser"
|
|
56
|
-
}
|
|
57
|
-
declare enum DashboardPages$1 {
|
|
58
|
-
Undefined_Page = "Undefined_Page",
|
|
59
|
-
/** Site dashboard home. */
|
|
60
|
-
Home = "Home"
|
|
61
|
-
}
|
|
62
|
-
interface Empty$1 {
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
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
|
-
toSiteContributors?: ToSiteContributors;
|
|
68
|
-
/** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
|
|
69
|
-
toContacts?: ToContacts;
|
|
70
|
-
/** URL to navigate to when the `action` text is clicked. */
|
|
71
|
-
targetUrl?: string | null;
|
|
72
|
-
/** Dashboard page to open when the notification action is clicked. */
|
|
73
|
-
targetDashboardPage?: DashboardPages;
|
|
74
|
-
/** Title of the notification. Max: 512 characters. */
|
|
75
|
-
title?: string | null;
|
|
76
|
-
/**
|
|
77
|
-
* Body of the notification. This contains the main content of the notification.
|
|
78
|
-
* Max: 512 characters
|
|
79
|
-
*/
|
|
80
|
-
body?: string | null;
|
|
81
|
-
/** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
|
|
82
|
-
action?: string | null;
|
|
83
|
-
/**
|
|
84
|
-
* Channel through which users receive the notification.
|
|
85
|
-
* - `"Mobile"`: Sends the notification to the Wix App.
|
|
86
|
-
* - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
|
|
87
|
-
* - `"Browser"`: Sends the notification to the collaborator's browser.
|
|
88
|
-
*/
|
|
89
|
-
channels?: Channel[];
|
|
90
|
-
}
|
|
91
|
-
/** @oneof */
|
|
92
|
-
interface PublicNotifyRequestRecipientsFilterOneOf {
|
|
93
|
-
/** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
|
|
94
|
-
toSiteContributors?: ToSiteContributors;
|
|
95
|
-
/** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
|
|
96
|
-
toContacts?: ToContacts;
|
|
97
|
-
}
|
|
98
|
-
/** @oneof */
|
|
99
|
-
interface PublicNotifyRequestActionTargetOneOf {
|
|
100
|
-
/** URL to navigate to when the `action` text is clicked. */
|
|
101
|
-
targetUrl?: string | null;
|
|
102
|
-
/** Dashboard page to open when the notification action is clicked. */
|
|
103
|
-
targetDashboardPage?: DashboardPages;
|
|
104
|
-
}
|
|
105
|
-
interface ToSiteContributors {
|
|
106
|
-
/**
|
|
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.
|
|
110
|
-
*/
|
|
111
|
-
withRole?: Role;
|
|
112
|
-
}
|
|
113
|
-
declare enum Role {
|
|
114
|
-
/** All site contributors. */
|
|
115
|
-
All_Contributors = "All_Contributors",
|
|
116
|
-
/** Site owner only. */
|
|
117
|
-
Owner = "Owner"
|
|
118
|
-
}
|
|
119
|
-
interface ToContacts {
|
|
120
|
-
/** Contacts that receive the notification. */
|
|
121
|
-
contactIds?: string[];
|
|
122
|
-
}
|
|
123
|
-
declare enum Channel {
|
|
124
|
-
/** No default channel. */
|
|
125
|
-
Undefined = "Undefined",
|
|
126
|
-
/** Site dashboard. */
|
|
127
|
-
Dashboard = "Dashboard",
|
|
128
|
-
/** [Wix Owner](https://www.wix.com/mobile/wix-app) mobile app. */
|
|
129
|
-
Mobile = "Mobile",
|
|
130
|
-
/** Active browser. Supported on Chrome and Safari only. */
|
|
131
|
-
Browser = "Browser"
|
|
132
|
-
}
|
|
133
|
-
declare enum DashboardPages {
|
|
134
|
-
Undefined_Page = "Undefined_Page",
|
|
135
|
-
/** Site dashboard home. */
|
|
136
|
-
Home = "Home"
|
|
137
|
-
}
|
|
138
|
-
interface Empty {
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
142
|
-
getUrl: (context: any) => string;
|
|
143
|
-
httpMethod: K;
|
|
144
|
-
path: string;
|
|
145
|
-
pathParams: M;
|
|
146
|
-
__requestType: T;
|
|
147
|
-
__originalRequestType: S;
|
|
148
|
-
__responseType: Q;
|
|
149
|
-
__originalResponseType: R;
|
|
150
|
-
};
|
|
151
|
-
declare function notify$1(): __PublicMethodMetaInfo$1<'POST', {}, PublicNotifyRequest, PublicNotifyRequest$1, Empty, Empty$1>;
|
|
152
|
-
|
|
153
|
-
declare namespace meta$1 {
|
|
154
|
-
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, notify$1 as notify };
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
interface NotifyRequest$1 {
|
|
158
|
-
/**
|
|
159
|
-
* Notification template ID. A notification template specifies the text and recipients for notifications.
|
|
160
|
-
* To obtain a notification template ID, create a notification template in your app's dashboard.
|
|
161
|
-
*/
|
|
162
|
-
notificationTemplateId: string;
|
|
163
|
-
/**
|
|
164
|
-
* Each key is a placeholder name you specify when creating a notification template.
|
|
165
|
-
* The value is an object containing the text to replace the placeholder in the notifications.
|
|
166
|
-
*/
|
|
167
|
-
dynamicValues?: Record<string, DynamicValue$1>;
|
|
168
|
-
}
|
|
169
|
-
interface DynamicValue$1 extends DynamicValueOfTypeOneOf$1 {
|
|
170
|
-
/** Text to be integrated into the notification. */
|
|
171
|
-
text?: string;
|
|
172
|
-
}
|
|
173
|
-
/** @oneof */
|
|
174
|
-
interface DynamicValueOfTypeOneOf$1 {
|
|
175
|
-
/** Text to be integrated into the notification. */
|
|
176
|
-
text?: string;
|
|
177
|
-
}
|
|
178
|
-
interface NotifyResponse$1 {
|
|
179
|
-
/** ID of the batch of notifications triggered by one request. */
|
|
180
|
-
notificationBatchId?: string;
|
|
181
|
-
}
|
|
182
|
-
interface NotifyResponseNonNullableFields$1 {
|
|
183
|
-
notificationBatchId: string;
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
interface NotifyRequest {
|
|
187
|
-
/**
|
|
188
|
-
* Notification template ID. A notification template specifies the text and recipients for notifications.
|
|
189
|
-
* To obtain a notification template ID, create a notification template in your app's dashboard.
|
|
190
|
-
*/
|
|
191
|
-
notificationTemplateId: string;
|
|
192
|
-
/**
|
|
193
|
-
* Each key is a placeholder name you specify when creating a notification template.
|
|
194
|
-
* The value is an object containing the text to replace the placeholder in the notifications.
|
|
195
|
-
*/
|
|
196
|
-
dynamicValues?: Record<string, DynamicValue>;
|
|
197
|
-
}
|
|
198
|
-
interface DynamicValue extends DynamicValueOfTypeOneOf {
|
|
199
|
-
/** Text to be integrated into the notification. */
|
|
200
|
-
text?: string;
|
|
201
|
-
}
|
|
202
|
-
/** @oneof */
|
|
203
|
-
interface DynamicValueOfTypeOneOf {
|
|
204
|
-
/** Text to be integrated into the notification. */
|
|
205
|
-
text?: string;
|
|
206
|
-
}
|
|
207
|
-
interface NotifyResponse {
|
|
208
|
-
/** ID of the batch of notifications triggered by one request. */
|
|
209
|
-
notificationBatchId?: string;
|
|
210
|
-
}
|
|
211
|
-
interface NotifyResponseNonNullableFields {
|
|
212
|
-
notificationBatchId: string;
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
216
|
-
getUrl: (context: any) => string;
|
|
217
|
-
httpMethod: K;
|
|
218
|
-
path: string;
|
|
219
|
-
pathParams: M;
|
|
220
|
-
__requestType: T;
|
|
221
|
-
__originalRequestType: S;
|
|
222
|
-
__responseType: Q;
|
|
223
|
-
__originalResponseType: R;
|
|
224
|
-
};
|
|
225
|
-
declare function notify(): __PublicMethodMetaInfo<'POST', {}, NotifyRequest, NotifyRequest$1, NotifyResponse & NotifyResponseNonNullableFields, NotifyResponse$1 & NotifyResponseNonNullableFields$1>;
|
|
226
|
-
|
|
227
|
-
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
228
|
-
declare const meta_notify: typeof notify;
|
|
229
|
-
declare namespace meta {
|
|
230
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_notify as notify };
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
export { meta$1 as notifications, meta as notificationsV3 };
|