@wix/notifications 1.0.10 → 1.0.12

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.
Files changed (13) hide show
  1. package/build/cjs/src/ping-notifications-v3-notification.public.d.ts +1 -1
  2. package/build/cjs/src/ping-notifications-v3-notification.types.d.ts +18 -2
  3. package/build/cjs/src/ping-notifications-v3-notification.types.js.map +1 -1
  4. package/build/cjs/src/ping-notifications-v3-notification.universal.d.ts +20 -2
  5. package/build/cjs/src/ping-notifications-v3-notification.universal.js +2 -0
  6. package/build/cjs/src/ping-notifications-v3-notification.universal.js.map +1 -1
  7. package/build/es/src/ping-notifications-v3-notification.public.d.ts +1 -1
  8. package/build/es/src/ping-notifications-v3-notification.types.d.ts +18 -2
  9. package/build/es/src/ping-notifications-v3-notification.types.js.map +1 -1
  10. package/build/es/src/ping-notifications-v3-notification.universal.d.ts +20 -2
  11. package/build/es/src/ping-notifications-v3-notification.universal.js +2 -0
  12. package/build/es/src/ping-notifications-v3-notification.universal.js.map +1 -1
  13. package/package.json +2 -2
package/build/cjs/src/ping-notifications-v3-notification.public.d.ts CHANGED
@@ -5,4 +5,4 @@ export declare const __metadata: {
5
5
  };
6
6
  export declare function notify(httpClient: HttpClient): (notificationTemplateId: string, options?: NotifyOptions | undefined) => Promise<import("./ping-notifications-v3-notification.universal").NotifyResponse>;
7
7
  export { TemplateChannel } from './ping-notifications-v3-notification.universal';
8
- export { Notification, NotifyRequest, DynamicValue, DynamicValueOfTypeOneOf, Money, MapDynamicValue, ArrayDynamicValue, NotifyResponse, NotifyByAppRequest, Overrides, ExcludedAudiences, ChannelsContent, MobilePushContent, NotifyByAppResponse, NotifyOptions, } from './ping-notifications-v3-notification.universal';
8
+ export { Notification, NotifyRequest, DynamicValue, DynamicValueOfTypeOneOf, Money, MapDynamicValue, ArrayDynamicValue, AttachmentDynamicValue, NotifyResponse, NotifyByAppRequest, Overrides, ExcludedAudiences, ChannelsContent, MobileContent, ChannelsData, EmailData, NotifyByAppResponse, NotifyOptions, } from './ping-notifications-v3-notification.universal';
package/build/cjs/src/ping-notifications-v3-notification.types.d.ts CHANGED
@@ -43,6 +43,12 @@ export interface ArrayDynamicValue {
43
43
  /** items */
44
44
  items?: DynamicValue[];
45
45
  }
46
+ export interface AttachmentDynamicValue {
47
+ /** file name */
48
+ fileName?: string;
49
+ /** download url */
50
+ downloadUrl?: string;
51
+ }
46
52
  export interface NotifyResponse {
47
53
  /** ID of the batch of notifications triggered by one request. */
48
54
  notificationBatchId?: string;
@@ -58,6 +64,8 @@ export interface NotifyByAppRequest {
58
64
  templateTenant?: string | null;
59
65
  /** overrides */
60
66
  overrides?: Overrides;
67
+ /** channels content */
68
+ channelsData?: ChannelsData;
61
69
  }
62
70
  export interface Overrides {
63
71
  /** excluded_channels */
@@ -83,14 +91,22 @@ export interface ExcludedAudiences {
83
91
  }
84
92
  export interface ChannelsContent {
85
93
  /** mobile push override */
86
- mobilePushContent?: MobilePushContent;
94
+ mobileContent?: MobileContent;
87
95
  }
88
- export interface MobilePushContent {
96
+ export interface MobileContent {
89
97
  /** title override of mobile push content */
90
98
  title?: string;
91
99
  /** body override of mobile push content */
92
100
  body?: string;
93
101
  }
102
+ export interface ChannelsData {
103
+ /** email data */
104
+ emailData?: EmailData;
105
+ }
106
+ export interface EmailData {
107
+ /** shoutout action config */
108
+ shoutoutActionConfig?: Record<string, any> | null;
109
+ }
94
110
  export interface NotifyByAppResponse {
95
111
  /** notification_batch_id */
96
112
  notificationBatchId?: string;
package/build/cjs/src/ping-notifications-v3-notification.types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ping-notifications-v3-notification.types.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.types.ts"],"names":[],"mappings":";;;AA+EA,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAS1B"}
1
+ {"version":3,"file":"ping-notifications-v3-notification.types.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.types.ts"],"names":[],"mappings":";;;AAwFA,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAS1B"}
package/build/cjs/src/ping-notifications-v3-notification.universal.d.ts CHANGED
@@ -49,6 +49,12 @@ export interface ArrayDynamicValue {
49
49
  /** items */
50
50
  items?: DynamicValue[];
51
51
  }
52
+ export interface AttachmentDynamicValue {
53
+ /** file name */
54
+ fileName?: string;
55
+ /** download url */
56
+ downloadUrl?: string;
57
+ }
52
58
  export interface NotifyResponse {
53
59
  /** ID of the batch of notifications triggered by one request. */
54
60
  notificationBatchId?: string;
@@ -64,6 +70,8 @@ export interface NotifyByAppRequest {
64
70
  templateTenant?: string | null;
65
71
  /** overrides */
66
72
  overrides?: Overrides;
73
+ /** channels content */
74
+ channelsData?: ChannelsData;
67
75
  }
68
76
  export interface Overrides {
69
77
  /** excluded_channels */
@@ -89,14 +97,22 @@ export interface ExcludedAudiences {
89
97
  }
90
98
  export interface ChannelsContent {
91
99
  /** mobile push override */
92
- mobilePushContent?: MobilePushContent;
100
+ mobileContent?: MobileContent;
93
101
  }
94
- export interface MobilePushContent {
102
+ export interface MobileContent {
95
103
  /** title override of mobile push content */
96
104
  title?: string;
97
105
  /** body override of mobile push content */
98
106
  body?: string;
99
107
  }
108
+ export interface ChannelsData {
109
+ /** email data */
110
+ emailData?: EmailData;
111
+ }
112
+ export interface EmailData {
113
+ /** shoutout action config */
114
+ shoutoutActionConfig?: Record<string, any> | null;
115
+ }
100
116
  export interface NotifyByAppResponse {
101
117
  /** notification_batch_id */
102
118
  notificationBatchId?: string;
@@ -117,6 +133,8 @@ export interface NotifyByAppResponse {
117
133
  * @public
118
134
  * @documentationMaturity preview
119
135
  * @requiredField notificationTemplateId
136
+ * @permissionScope Manage Notifications
137
+ * @applicableIdentity APP
120
138
  */
121
139
  export declare function notify(notificationTemplateId: string, options?: NotifyOptions): Promise<NotifyResponse>;
122
140
  export interface NotifyOptions {
package/build/cjs/src/ping-notifications-v3-notification.universal.js CHANGED
@@ -78,6 +78,8 @@ const _notifyResponse = {};
78
78
  * @public
79
79
  * @documentationMaturity preview
80
80
  * @requiredField notificationTemplateId
81
+ * @permissionScope Manage Notifications
82
+ * @applicableIdentity APP
81
83
  */
82
84
  function notify(notificationTemplateId, options) {
83
85
  var _a, _b, _c;
package/build/cjs/src/ping-notifications-v3-notification.universal.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ping-notifications-v3-notification.universal.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,wHAA0G;AAE1G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAiF5B,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAS1B;AAwBD,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;AACtD,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;AAC/E,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;AACxD,MAAM,cAAc,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC;AAC9D,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,MAAM,CAC1B,sBAA8B,EAC9B,OAAuB;;;QAEvB,MAAM,qBAAqB,GAAG;YAC5B,sBAAsB,EAAE,MAAM;YAC9B,aAAa,EAAE,oBAAoB;SACpC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,gBAAgB,EAAE;YACnE,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;QAEvE,MAAM,OAAO,GAAG,4CAA4C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,wBAAwB;gBACxB,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAzDD,wBAyDC"}
1
+ {"version":3,"file":"ping-notifications-v3-notification.universal.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,wHAA0G;AAE1G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0F5B,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAS1B;AAkCD,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;AACtD,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;AAC/E,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;AACxD,MAAM,cAAc,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC;AAC9D,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAsB,MAAM,CAC1B,sBAA8B,EAC9B,OAAuB;;;QAEvB,MAAM,qBAAqB,GAAG;YAC5B,sBAAsB,EAAE,MAAM;YAC9B,aAAa,EAAE,oBAAoB;SACpC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,gBAAgB,EAAE;YACnE,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;QAEvE,MAAM,OAAO,GAAG,4CAA4C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,wBAAwB;gBACxB,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAzDD,wBAyDC"}
package/build/es/src/ping-notifications-v3-notification.public.d.ts CHANGED
@@ -5,4 +5,4 @@ export declare const __metadata: {
5
5
  };
6
6
  export declare function notify(httpClient: HttpClient): (notificationTemplateId: string, options?: NotifyOptions | undefined) => Promise<import("./ping-notifications-v3-notification.universal").NotifyResponse>;
7
7
  export { TemplateChannel } from './ping-notifications-v3-notification.universal';
8
- export { Notification, NotifyRequest, DynamicValue, DynamicValueOfTypeOneOf, Money, MapDynamicValue, ArrayDynamicValue, NotifyResponse, NotifyByAppRequest, Overrides, ExcludedAudiences, ChannelsContent, MobilePushContent, NotifyByAppResponse, NotifyOptions, } from './ping-notifications-v3-notification.universal';
8
+ export { Notification, NotifyRequest, DynamicValue, DynamicValueOfTypeOneOf, Money, MapDynamicValue, ArrayDynamicValue, AttachmentDynamicValue, NotifyResponse, NotifyByAppRequest, Overrides, ExcludedAudiences, ChannelsContent, MobileContent, ChannelsData, EmailData, NotifyByAppResponse, NotifyOptions, } from './ping-notifications-v3-notification.universal';
package/build/es/src/ping-notifications-v3-notification.types.d.ts CHANGED
@@ -43,6 +43,12 @@ export interface ArrayDynamicValue {
43
43
  /** items */
44
44
  items?: DynamicValue[];
45
45
  }
46
+ export interface AttachmentDynamicValue {
47
+ /** file name */
48
+ fileName?: string;
49
+ /** download url */
50
+ downloadUrl?: string;
51
+ }
46
52
  export interface NotifyResponse {
47
53
  /** ID of the batch of notifications triggered by one request. */
48
54
  notificationBatchId?: string;
@@ -58,6 +64,8 @@ export interface NotifyByAppRequest {
58
64
  templateTenant?: string | null;
59
65
  /** overrides */
60
66
  overrides?: Overrides;
67
+ /** channels content */
68
+ channelsData?: ChannelsData;
61
69
  }
62
70
  export interface Overrides {
63
71
  /** excluded_channels */
@@ -83,14 +91,22 @@ export interface ExcludedAudiences {
83
91
  }
84
92
  export interface ChannelsContent {
85
93
  /** mobile push override */
86
- mobilePushContent?: MobilePushContent;
94
+ mobileContent?: MobileContent;
87
95
  }
88
- export interface MobilePushContent {
96
+ export interface MobileContent {
89
97
  /** title override of mobile push content */
90
98
  title?: string;
91
99
  /** body override of mobile push content */
92
100
  body?: string;
93
101
  }
102
+ export interface ChannelsData {
103
+ /** email data */
104
+ emailData?: EmailData;
105
+ }
106
+ export interface EmailData {
107
+ /** shoutout action config */
108
+ shoutoutActionConfig?: Record<string, any> | null;
109
+ }
94
110
  export interface NotifyByAppResponse {
95
111
  /** notification_batch_id */
96
112
  notificationBatchId?: string;
package/build/es/src/ping-notifications-v3-notification.types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ping-notifications-v3-notification.types.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.types.ts"],"names":[],"mappings":"AA+EA,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B"}
1
+ {"version":3,"file":"ping-notifications-v3-notification.types.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.types.ts"],"names":[],"mappings":"AAwFA,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B"}
package/build/es/src/ping-notifications-v3-notification.universal.d.ts CHANGED
@@ -49,6 +49,12 @@ export interface ArrayDynamicValue {
49
49
  /** items */
50
50
  items?: DynamicValue[];
51
51
  }
52
+ export interface AttachmentDynamicValue {
53
+ /** file name */
54
+ fileName?: string;
55
+ /** download url */
56
+ downloadUrl?: string;
57
+ }
52
58
  export interface NotifyResponse {
53
59
  /** ID of the batch of notifications triggered by one request. */
54
60
  notificationBatchId?: string;
@@ -64,6 +70,8 @@ export interface NotifyByAppRequest {
64
70
  templateTenant?: string | null;
65
71
  /** overrides */
66
72
  overrides?: Overrides;
73
+ /** channels content */
74
+ channelsData?: ChannelsData;
67
75
  }
68
76
  export interface Overrides {
69
77
  /** excluded_channels */
@@ -89,14 +97,22 @@ export interface ExcludedAudiences {
89
97
  }
90
98
  export interface ChannelsContent {
91
99
  /** mobile push override */
92
- mobilePushContent?: MobilePushContent;
100
+ mobileContent?: MobileContent;
93
101
  }
94
- export interface MobilePushContent {
102
+ export interface MobileContent {
95
103
  /** title override of mobile push content */
96
104
  title?: string;
97
105
  /** body override of mobile push content */
98
106
  body?: string;
99
107
  }
108
+ export interface ChannelsData {
109
+ /** email data */
110
+ emailData?: EmailData;
111
+ }
112
+ export interface EmailData {
113
+ /** shoutout action config */
114
+ shoutoutActionConfig?: Record<string, any> | null;
115
+ }
100
116
  export interface NotifyByAppResponse {
101
117
  /** notification_batch_id */
102
118
  notificationBatchId?: string;
@@ -117,6 +133,8 @@ export interface NotifyByAppResponse {
117
133
  * @public
118
134
  * @documentationMaturity preview
119
135
  * @requiredField notificationTemplateId
136
+ * @permissionScope Manage Notifications
137
+ * @applicableIdentity APP
120
138
  */
121
139
  export declare function notify(notificationTemplateId: string, options?: NotifyOptions): Promise<NotifyResponse>;
122
140
  export interface NotifyOptions {
package/build/es/src/ping-notifications-v3-notification.universal.js CHANGED
@@ -56,6 +56,8 @@ const _notifyResponse = {};
56
56
  * @public
57
57
  * @documentationMaturity preview
58
58
  * @requiredField notificationTemplateId
59
+ * @permissionScope Manage Notifications
60
+ * @applicableIdentity APP
59
61
  */
60
62
  export function notify(notificationTemplateId, options) {
61
63
  var _a, _b, _c;
package/build/es/src/ping-notifications-v3-notification.universal.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ping-notifications-v3-notification.universal.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,4CAA4C,MAAM,2CAA2C,CAAC;AAE1G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAiF5B,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AAwBD,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;AACtD,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;AAC/E,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;AACxD,MAAM,cAAc,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC;AAC9D,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAgB,MAAM,CAC1B,sBAA8B,EAC9B,OAAuB;;;QAEvB,MAAM,qBAAqB,GAAG;YAC5B,sBAAsB,EAAE,MAAM;YAC9B,aAAa,EAAE,oBAAoB;SACpC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,gBAAgB,EAAE;YACnE,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;QAEvE,MAAM,OAAO,GAAG,4CAA4C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,wBAAwB;gBACxB,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}
1
+ {"version":3,"file":"ping-notifications-v3-notification.universal.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,4CAA4C,MAAM,2CAA2C,CAAC;AAE1G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0F5B,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AAkCD,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;AACtD,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;AAC/E,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;AACxD,MAAM,cAAc,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC;AAC9D,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAgB,MAAM,CAC1B,sBAA8B,EAC9B,OAAuB;;;QAEvB,MAAM,qBAAqB,GAAG;YAC5B,sBAAsB,EAAE,MAAM;YAC9B,aAAa,EAAE,oBAAoB;SACpC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,gBAAgB,EAAE;YACnE,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;QAEvE,MAAM,OAAO,GAAG,4CAA4C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,wBAAwB;gBACxB,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/notifications",
3
- "version": "1.0.10",
3
+ "version": "1.0.12",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "2724b148c2398e82d001fb3573a3007ea7f6385db93006eb90b31cc2"
36
+ "falconPackageHash": "c8990ef033eb2762a412d5e5d109ce90a48b0b8060080d37b2c720be"
37
37
  }