@wix/notifications 1.0.30 → 1.0.32

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.30",
3
+ "version": "1.0.32",
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.17",
22
- "@wix/notifications_notifications-v-3": "1.0.0"
21
+ "@wix/notifications_notifications": "1.0.18",
22
+ "@wix/notifications_notifications-v-3": "1.0.2"
23
23
  },
24
24
  "devDependencies": {
25
25
  "glob": "^10.4.1",
@@ -44,5 +44,5 @@
44
44
  "fqdn": ""
45
45
  }
46
46
  },
47
- "falconPackageHash": "e98c4f383d4906128930faa463a868a1f1f7181718da521b90dfc1bb"
47
+ "falconPackageHash": "3042c82abcb6f5249a17c5eb48a30da64091eb3beeee6c8409e7eead"
48
48
  }
@@ -136,10 +136,7 @@ interface NotifySignature$1 {
136
136
  (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;
137
137
  }
138
138
 
139
- declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
140
-
141
- type _publicNotifyType$1 = typeof notify$3;
142
- declare const notify$2: ReturnType<typeof createRESTModule$1<_publicNotifyType>>;
139
+ declare const notify$2: BuildRESTFunction<typeof notify$3> & typeof notify$3;
143
140
 
144
141
  type context$1_Channel = Channel;
145
142
  declare const context$1_Channel: typeof Channel;
@@ -156,7 +153,7 @@ type context$1_ToContacts = ToContacts;
156
153
  type context$1_ToSiteContributors = ToSiteContributors;
157
154
  type context$1_ToTopicsSubscribers = ToTopicsSubscribers;
158
155
  declare namespace context$1 {
159
- export { context$1_Channel as Channel, context$1_DashboardPages as DashboardPages, type context$1_Empty as Empty, type NotifyOptions$1 as NotifyOptions, type context$1_PublicNotifyRequest as PublicNotifyRequest, type context$1_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type context$1_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type context$1_Public_notification as Public_notification, context$1_Role as Role, type context$1_ToContacts as ToContacts, type context$1_ToSiteContributors as ToSiteContributors, type context$1_ToTopicsSubscribers as ToTopicsSubscribers, type _publicNotifyType$1 as _publicNotifyType, notify$2 as notify };
156
+ export { context$1_Channel as Channel, context$1_DashboardPages as DashboardPages, type context$1_Empty as Empty, type NotifyOptions$1 as NotifyOptions, type context$1_PublicNotifyRequest as PublicNotifyRequest, type context$1_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type context$1_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type context$1_Public_notification as Public_notification, context$1_Role as Role, type context$1_ToContacts as ToContacts, type context$1_ToSiteContributors as ToSiteContributors, type context$1_ToTopicsSubscribers as ToTopicsSubscribers, notify$2 as notify };
160
157
  }
161
158
 
162
159
  interface Notification {
@@ -166,11 +163,11 @@ interface Notification {
166
163
  interface NotifyRequest {
167
164
  /**
168
165
  * Notification template ID. A notification template specifies the text and recipients for notifications.
169
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
166
+ * To obtain a notification template ID, create a notification template in the Wix Dev Center.
170
167
  */
171
168
  notificationTemplateId: string;
172
169
  /**
173
- * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
170
+ * Each key is a placeholder name you specify when creating a notification template.
174
171
  * The value is an object containing the text to replace the placeholder in the notifications.
175
172
  */
176
173
  dynamicValues?: Record<string, DynamicValue>;
@@ -285,7 +282,7 @@ interface NotifyResponseNonNullableFields {
285
282
  }
286
283
  interface NotifyOptions {
287
284
  /**
288
- * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
285
+ * Each key is a placeholder name you specify when creating a notification template.
289
286
  * The value is an object containing the text to replace the placeholder in the notifications.
290
287
  */
291
288
  dynamicValues?: Record<string, DynamicValue>;
@@ -300,20 +297,17 @@ interface NotifySignature {
300
297
  *
301
298
  * An app can call this endpoint up to 100,000 times per month for each site.
302
299
  *
303
- * When you [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center, you are given a notification template ID.
300
+ * When you create a notification template in the Wix Dev Center, you are given a notification template ID.
304
301
  * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.
305
302
  * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.
306
303
  * The values you specify are incorporated seamlessly in the notifications sent out.
307
304
  * @param - Notification template ID. A notification template specifies the text and recipients for notifications.
308
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
305
+ * To obtain a notification template ID, create a notification template in the Wix Dev Center.
309
306
  */
310
307
  (notificationTemplateId: string, options?: NotifyOptions | undefined): Promise<NotifyResponse & NotifyResponseNonNullableFields>;
311
308
  }
312
309
 
313
- declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
314
-
315
- type _publicNotifyType = typeof notify$1;
316
- declare const notify: ReturnType<typeof createRESTModule<_publicNotifyType>>;
310
+ declare const notify: BuildRESTFunction<typeof notify$1> & typeof notify$1;
317
311
 
318
312
  type context_ArrayDynamicValue = ArrayDynamicValue;
319
313
  type context_AttachmentDynamicValue = AttachmentDynamicValue;
@@ -338,10 +332,9 @@ type context_ResolveRequest = ResolveRequest;
338
332
  type context_ResolveResponse = ResolveResponse;
339
333
  type context_TemplateChannel = TemplateChannel;
340
334
  declare const context_TemplateChannel: typeof TemplateChannel;
341
- type context__publicNotifyType = _publicNotifyType;
342
335
  declare const context_notify: typeof notify;
343
336
  declare namespace context {
344
- export { type context_ArrayDynamicValue as ArrayDynamicValue, type context_AttachmentDynamicValue as AttachmentDynamicValue, type context_ChannelsContent as ChannelsContent, type context_ChannelsData as ChannelsData, type context_DynamicValue as DynamicValue, type context_DynamicValueOfTypeOneOf as DynamicValueOfTypeOneOf, type context_EmailData as EmailData, type context_ExcludedAudiences as ExcludedAudiences, type context_MapDynamicValue as MapDynamicValue, type context_MobileContent as MobileContent, type context_Money as Money, type context_Notification as Notification, type context_NotifyByAppRequest as NotifyByAppRequest, type context_NotifyByAppResponse as NotifyByAppResponse, type context_NotifyOptions as NotifyOptions, type context_NotifyRequest as NotifyRequest, type context_NotifyResponse as NotifyResponse, type context_NotifyResponseNonNullableFields as NotifyResponseNonNullableFields, type context_Overrides as Overrides, type context_ResolveRequest as ResolveRequest, type context_ResolveResponse as ResolveResponse, context_TemplateChannel as TemplateChannel, type context__publicNotifyType as _publicNotifyType, context_notify as notify };
337
+ export { type context_ArrayDynamicValue as ArrayDynamicValue, type context_AttachmentDynamicValue as AttachmentDynamicValue, type context_ChannelsContent as ChannelsContent, type context_ChannelsData as ChannelsData, type context_DynamicValue as DynamicValue, type context_DynamicValueOfTypeOneOf as DynamicValueOfTypeOneOf, type context_EmailData as EmailData, type context_ExcludedAudiences as ExcludedAudiences, type context_MapDynamicValue as MapDynamicValue, type context_MobileContent as MobileContent, type context_Money as Money, type context_Notification as Notification, type context_NotifyByAppRequest as NotifyByAppRequest, type context_NotifyByAppResponse as NotifyByAppResponse, type context_NotifyOptions as NotifyOptions, type context_NotifyRequest as NotifyRequest, type context_NotifyResponse as NotifyResponse, type context_NotifyResponseNonNullableFields as NotifyResponseNonNullableFields, type context_Overrides as Overrides, type context_ResolveRequest as ResolveRequest, type context_ResolveResponse as ResolveResponse, context_TemplateChannel as TemplateChannel, context_notify as notify };
345
338
  }
346
339
 
347
340
  export { context$1 as notifications, context as notificationsV3 };
@@ -136,10 +136,7 @@ interface NotifySignature$1 {
136
136
  (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;
137
137
  }
138
138
 
139
- declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
140
-
141
- type _publicNotifyType$1 = typeof notify$3;
142
- declare const notify$2: ReturnType<typeof createRESTModule$1<_publicNotifyType>>;
139
+ declare const notify$2: BuildRESTFunction<typeof notify$3> & typeof notify$3;
143
140
 
144
141
  type index_d$1_Channel = Channel;
145
142
  declare const index_d$1_Channel: typeof Channel;
@@ -156,7 +153,7 @@ type index_d$1_ToContacts = ToContacts;
156
153
  type index_d$1_ToSiteContributors = ToSiteContributors;
157
154
  type index_d$1_ToTopicsSubscribers = ToTopicsSubscribers;
158
155
  declare namespace index_d$1 {
159
- export { index_d$1_Channel as Channel, index_d$1_DashboardPages as DashboardPages, type index_d$1_Empty as Empty, type NotifyOptions$1 as NotifyOptions, type index_d$1_PublicNotifyRequest as PublicNotifyRequest, type index_d$1_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type index_d$1_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type index_d$1_Public_notification as Public_notification, index_d$1_Role as Role, type index_d$1_ToContacts as ToContacts, type index_d$1_ToSiteContributors as ToSiteContributors, type index_d$1_ToTopicsSubscribers as ToTopicsSubscribers, type _publicNotifyType$1 as _publicNotifyType, notify$2 as notify };
156
+ export { index_d$1_Channel as Channel, index_d$1_DashboardPages as DashboardPages, type index_d$1_Empty as Empty, type NotifyOptions$1 as NotifyOptions, type index_d$1_PublicNotifyRequest as PublicNotifyRequest, type index_d$1_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type index_d$1_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type index_d$1_Public_notification as Public_notification, index_d$1_Role as Role, type index_d$1_ToContacts as ToContacts, type index_d$1_ToSiteContributors as ToSiteContributors, type index_d$1_ToTopicsSubscribers as ToTopicsSubscribers, notify$2 as notify };
160
157
  }
161
158
 
162
159
  interface Notification {
@@ -166,11 +163,11 @@ interface Notification {
166
163
  interface NotifyRequest {
167
164
  /**
168
165
  * Notification template ID. A notification template specifies the text and recipients for notifications.
169
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
166
+ * To obtain a notification template ID, create a notification template in the Wix Dev Center.
170
167
  */
171
168
  notificationTemplateId: string;
172
169
  /**
173
- * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
170
+ * Each key is a placeholder name you specify when creating a notification template.
174
171
  * The value is an object containing the text to replace the placeholder in the notifications.
175
172
  */
176
173
  dynamicValues?: Record<string, DynamicValue>;
@@ -285,7 +282,7 @@ interface NotifyResponseNonNullableFields {
285
282
  }
286
283
  interface NotifyOptions {
287
284
  /**
288
- * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
285
+ * Each key is a placeholder name you specify when creating a notification template.
289
286
  * The value is an object containing the text to replace the placeholder in the notifications.
290
287
  */
291
288
  dynamicValues?: Record<string, DynamicValue>;
@@ -300,20 +297,17 @@ interface NotifySignature {
300
297
  *
301
298
  * An app can call this endpoint up to 100,000 times per month for each site.
302
299
  *
303
- * When you [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center, you are given a notification template ID.
300
+ * When you create a notification template in the Wix Dev Center, you are given a notification template ID.
304
301
  * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.
305
302
  * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.
306
303
  * The values you specify are incorporated seamlessly in the notifications sent out.
307
304
  * @param - Notification template ID. A notification template specifies the text and recipients for notifications.
308
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
305
+ * To obtain a notification template ID, create a notification template in the Wix Dev Center.
309
306
  */
310
307
  (notificationTemplateId: string, options?: NotifyOptions | undefined): Promise<NotifyResponse & NotifyResponseNonNullableFields>;
311
308
  }
312
309
 
313
- declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
314
-
315
- type _publicNotifyType = typeof notify$1;
316
- declare const notify: ReturnType<typeof createRESTModule<_publicNotifyType>>;
310
+ declare const notify: BuildRESTFunction<typeof notify$1> & typeof notify$1;
317
311
 
318
312
  type index_d_ArrayDynamicValue = ArrayDynamicValue;
319
313
  type index_d_AttachmentDynamicValue = AttachmentDynamicValue;
@@ -338,10 +332,9 @@ type index_d_ResolveRequest = ResolveRequest;
338
332
  type index_d_ResolveResponse = ResolveResponse;
339
333
  type index_d_TemplateChannel = TemplateChannel;
340
334
  declare const index_d_TemplateChannel: typeof TemplateChannel;
341
- type index_d__publicNotifyType = _publicNotifyType;
342
335
  declare const index_d_notify: typeof notify;
343
336
  declare namespace index_d {
344
- export { type index_d_ArrayDynamicValue as ArrayDynamicValue, type index_d_AttachmentDynamicValue as AttachmentDynamicValue, type index_d_ChannelsContent as ChannelsContent, type index_d_ChannelsData as ChannelsData, type index_d_DynamicValue as DynamicValue, type index_d_DynamicValueOfTypeOneOf as DynamicValueOfTypeOneOf, type index_d_EmailData as EmailData, type index_d_ExcludedAudiences as ExcludedAudiences, type index_d_MapDynamicValue as MapDynamicValue, type index_d_MobileContent as MobileContent, type index_d_Money as Money, type index_d_Notification as Notification, type index_d_NotifyByAppRequest as NotifyByAppRequest, type index_d_NotifyByAppResponse as NotifyByAppResponse, type index_d_NotifyOptions as NotifyOptions, type index_d_NotifyRequest as NotifyRequest, type index_d_NotifyResponse as NotifyResponse, type index_d_NotifyResponseNonNullableFields as NotifyResponseNonNullableFields, type index_d_Overrides as Overrides, type index_d_ResolveRequest as ResolveRequest, type index_d_ResolveResponse as ResolveResponse, index_d_TemplateChannel as TemplateChannel, type index_d__publicNotifyType as _publicNotifyType, index_d_notify as notify };
337
+ export { type index_d_ArrayDynamicValue as ArrayDynamicValue, type index_d_AttachmentDynamicValue as AttachmentDynamicValue, type index_d_ChannelsContent as ChannelsContent, type index_d_ChannelsData as ChannelsData, type index_d_DynamicValue as DynamicValue, type index_d_DynamicValueOfTypeOneOf as DynamicValueOfTypeOneOf, type index_d_EmailData as EmailData, type index_d_ExcludedAudiences as ExcludedAudiences, type index_d_MapDynamicValue as MapDynamicValue, type index_d_MobileContent as MobileContent, type index_d_Money as Money, type index_d_Notification as Notification, type index_d_NotifyByAppRequest as NotifyByAppRequest, type index_d_NotifyByAppResponse as NotifyByAppResponse, type index_d_NotifyOptions as NotifyOptions, type index_d_NotifyRequest as NotifyRequest, type index_d_NotifyResponse as NotifyResponse, type index_d_NotifyResponseNonNullableFields as NotifyResponseNonNullableFields, type index_d_Overrides as Overrides, type index_d_ResolveRequest as ResolveRequest, type index_d_ResolveResponse as ResolveResponse, index_d_TemplateChannel as TemplateChannel, index_d_notify as notify };
345
338
  }
346
339
 
347
340
  export { index_d$1 as notifications, index_d as notificationsV3 };
@@ -165,11 +165,11 @@ declare namespace meta$1 {
165
165
  interface NotifyRequest$1 {
166
166
  /**
167
167
  * Notification template ID. A notification template specifies the text and recipients for notifications.
168
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
168
+ * To obtain a notification template ID, create a notification template in the Wix Dev Center.
169
169
  */
170
170
  notificationTemplateId: string;
171
171
  /**
172
- * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
172
+ * Each key is a placeholder name you specify when creating a notification template.
173
173
  * The value is an object containing the text to replace the placeholder in the notifications.
174
174
  */
175
175
  dynamicValues?: Record<string, DynamicValue$1>;
@@ -194,11 +194,11 @@ interface NotifyResponseNonNullableFields$1 {
194
194
  interface NotifyRequest {
195
195
  /**
196
196
  * Notification template ID. A notification template specifies the text and recipients for notifications.
197
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
197
+ * To obtain a notification template ID, create a notification template in the Wix Dev Center.
198
198
  */
199
199
  notificationTemplateId: string;
200
200
  /**
201
- * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
201
+ * Each key is a placeholder name you specify when creating a notification template.
202
202
  * The value is an object containing the text to replace the placeholder in the notifications.
203
203
  */
204
204
  dynamicValues?: Record<string, DynamicValue>;