@wix/auto_sdk_email-marketing_sender-details 1.0.5 → 1.0.7
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/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +12 -18
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +30 -34
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +8 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +12 -18
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +30 -34
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js +8 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +12 -18
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +30 -34
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +8 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +12 -18
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +30 -34
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js +8 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -61,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
61
61
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
62
|
deletedEvent?: EntityDeletedEvent;
|
|
63
63
|
actionEvent?: ActionEvent;
|
|
64
|
-
/**
|
|
65
|
-
* Unique event ID.
|
|
66
|
-
* Allows clients to ignore duplicate webhooks.
|
|
67
|
-
*/
|
|
64
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
68
65
|
id?: string;
|
|
69
66
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
67
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
68
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
72
69
|
*/
|
|
73
70
|
entityFqdn?: string;
|
|
74
71
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
72
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
73
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
78
74
|
*/
|
|
79
75
|
slug?: string;
|
|
80
76
|
/** ID of the entity associated with the event. */
|
|
81
77
|
entityId?: string;
|
|
82
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
78
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
83
79
|
eventTime?: Date | null;
|
|
84
80
|
/**
|
|
85
81
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -89,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
89
85
|
/** If present, indicates the action that triggered the event. */
|
|
90
86
|
originatedFrom?: string | null;
|
|
91
87
|
/**
|
|
92
|
-
* A sequence number
|
|
93
|
-
*
|
|
94
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
95
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
96
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
97
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
88
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
89
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
98
90
|
*/
|
|
99
91
|
entityEventSequence?: string | null;
|
|
100
92
|
}
|
|
@@ -122,7 +114,7 @@ export interface EntityUpdatedEvent {
|
|
|
122
114
|
currentEntityAsJson?: string;
|
|
123
115
|
}
|
|
124
116
|
export interface EntityDeletedEvent {
|
|
125
|
-
/** Entity that was deleted */
|
|
117
|
+
/** Entity that was deleted. */
|
|
126
118
|
deletedEntityAsJson?: string | null;
|
|
127
119
|
}
|
|
128
120
|
export interface ActionEvent {
|
|
@@ -166,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
166
158
|
*/
|
|
167
159
|
appId?: string;
|
|
168
160
|
/** @readonly */
|
|
169
|
-
identityType?:
|
|
161
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
170
162
|
}
|
|
171
163
|
/** @oneof */
|
|
172
164
|
export interface IdentificationDataIdOneOf {
|
|
@@ -198,3 +190,5 @@ export declare enum WebhookIdentityType {
|
|
|
198
190
|
WIX_USER = "WIX_USER",
|
|
199
191
|
APP = "APP"
|
|
200
192
|
}
|
|
193
|
+
/** @enumType */
|
|
194
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":";;;AA0MA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
|
@@ -62,25 +62,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
62
62
|
updatedEvent?: EntityUpdatedEvent;
|
|
63
63
|
deletedEvent?: EntityDeletedEvent;
|
|
64
64
|
actionEvent?: ActionEvent;
|
|
65
|
-
/**
|
|
66
|
-
* Unique event ID.
|
|
67
|
-
* Allows clients to ignore duplicate webhooks.
|
|
68
|
-
*/
|
|
65
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
69
66
|
_id?: string;
|
|
70
67
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
68
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
69
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
73
70
|
*/
|
|
74
71
|
entityFqdn?: string;
|
|
75
72
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
73
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
74
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
79
75
|
*/
|
|
80
76
|
slug?: string;
|
|
81
77
|
/** ID of the entity associated with the event. */
|
|
82
78
|
entityId?: string;
|
|
83
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
79
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
84
80
|
eventTime?: Date | null;
|
|
85
81
|
/**
|
|
86
82
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -90,12 +86,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
90
86
|
/** If present, indicates the action that triggered the event. */
|
|
91
87
|
originatedFrom?: string | null;
|
|
92
88
|
/**
|
|
93
|
-
* A sequence number
|
|
94
|
-
*
|
|
95
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
96
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
97
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
98
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
89
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
90
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
99
91
|
*/
|
|
100
92
|
entityEventSequence?: string | null;
|
|
101
93
|
}
|
|
@@ -121,7 +113,7 @@ export interface EntityUpdatedEvent {
|
|
|
121
113
|
currentEntity?: string;
|
|
122
114
|
}
|
|
123
115
|
export interface EntityDeletedEvent {
|
|
124
|
-
/** Entity that was deleted */
|
|
116
|
+
/** Entity that was deleted. */
|
|
125
117
|
deletedEntity?: string | null;
|
|
126
118
|
}
|
|
127
119
|
export interface ActionEvent {
|
|
@@ -165,7 +157,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
165
157
|
*/
|
|
166
158
|
appId?: string;
|
|
167
159
|
/** @readonly */
|
|
168
|
-
identityType?:
|
|
160
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
169
161
|
}
|
|
170
162
|
/** @oneof */
|
|
171
163
|
export interface IdentificationDataIdOneOf {
|
|
@@ -197,6 +189,8 @@ export declare enum WebhookIdentityType {
|
|
|
197
189
|
WIX_USER = "WIX_USER",
|
|
198
190
|
APP = "APP"
|
|
199
191
|
}
|
|
192
|
+
/** @enumType */
|
|
193
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
200
194
|
export interface BaseEventMetadata {
|
|
201
195
|
/**
|
|
202
196
|
* App instance ID.
|
|
@@ -212,25 +206,21 @@ export interface BaseEventMetadata {
|
|
|
212
206
|
identity?: IdentificationData;
|
|
213
207
|
}
|
|
214
208
|
export interface EventMetadata extends BaseEventMetadata {
|
|
215
|
-
/**
|
|
216
|
-
* Unique event ID.
|
|
217
|
-
* Allows clients to ignore duplicate webhooks.
|
|
218
|
-
*/
|
|
209
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
219
210
|
_id?: string;
|
|
220
211
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
212
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
213
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
223
214
|
*/
|
|
224
215
|
entityFqdn?: string;
|
|
225
216
|
/**
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
217
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
218
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
229
219
|
*/
|
|
230
220
|
slug?: string;
|
|
231
221
|
/** ID of the entity associated with the event. */
|
|
232
222
|
entityId?: string;
|
|
233
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
223
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
234
224
|
eventTime?: Date | null;
|
|
235
225
|
/**
|
|
236
226
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -240,12 +230,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
240
230
|
/** If present, indicates the action that triggered the event. */
|
|
241
231
|
originatedFrom?: string | null;
|
|
242
232
|
/**
|
|
243
|
-
* A sequence number
|
|
244
|
-
*
|
|
245
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
246
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
247
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
248
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
233
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
234
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
249
235
|
*/
|
|
250
236
|
entityEventSequence?: string | null;
|
|
251
237
|
}
|
|
@@ -255,6 +241,8 @@ export interface SenderDetailsUpdatedEnvelope {
|
|
|
255
241
|
}
|
|
256
242
|
/**
|
|
257
243
|
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
244
|
+
* @permissionScope Manage Stores
|
|
245
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
258
246
|
* @permissionScope Access Verticals by Automations
|
|
259
247
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
260
248
|
* @permissionScope Set Up Automations
|
|
@@ -281,6 +269,8 @@ type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
|
|
|
281
269
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
282
270
|
* @public
|
|
283
271
|
* @permissionId Shoutout.Manage
|
|
272
|
+
* @permissionScope Manage Stores
|
|
273
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
284
274
|
* @permissionScope Access Verticals by Automations
|
|
285
275
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
286
276
|
* @permissionScope Set Up Automations
|
|
@@ -305,6 +295,8 @@ export declare function getSenderDetails(): Promise<NonNullablePaths<GetSenderDe
|
|
|
305
295
|
* @public
|
|
306
296
|
* @requiredField senderDetails
|
|
307
297
|
* @permissionId Shoutout.Manage
|
|
298
|
+
* @permissionScope Manage Stores
|
|
299
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
308
300
|
* @permissionScope Access Verticals by Automations
|
|
309
301
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
310
302
|
* @permissionScope Set Up Automations
|
|
@@ -324,6 +316,8 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
|
|
|
324
316
|
* @public
|
|
325
317
|
* @requiredField verificationCode
|
|
326
318
|
* @permissionId Shoutout.Manage
|
|
319
|
+
* @permissionScope Manage Stores
|
|
320
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
327
321
|
* @permissionScope Access Verticals by Automations
|
|
328
322
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
329
323
|
* @permissionScope Set Up Automations
|
|
@@ -343,6 +337,8 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
|
|
|
343
337
|
* @public
|
|
344
338
|
* @requiredField fromAddress
|
|
345
339
|
* @permissionId Shoutout.Manage
|
|
340
|
+
* @permissionScope Manage Stores
|
|
341
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
346
342
|
* @permissionScope Access Verticals by Automations
|
|
347
343
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
348
344
|
* @permissionScope Set Up Automations
|
|
@@ -45,6 +45,8 @@ var WebhookIdentityType;
|
|
|
45
45
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
46
46
|
* @public
|
|
47
47
|
* @permissionId Shoutout.Manage
|
|
48
|
+
* @permissionScope Manage Stores
|
|
49
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
48
50
|
* @permissionScope Access Verticals by Automations
|
|
49
51
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
50
52
|
* @permissionScope Set Up Automations
|
|
@@ -88,6 +90,8 @@ exports.getSenderDetails = getSenderDetails;
|
|
|
88
90
|
* @public
|
|
89
91
|
* @requiredField senderDetails
|
|
90
92
|
* @permissionId Shoutout.Manage
|
|
93
|
+
* @permissionScope Manage Stores
|
|
94
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
91
95
|
* @permissionScope Access Verticals by Automations
|
|
92
96
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
93
97
|
* @permissionScope Set Up Automations
|
|
@@ -130,6 +134,8 @@ exports.updateSenderDetails = updateSenderDetails;
|
|
|
130
134
|
* @public
|
|
131
135
|
* @requiredField verificationCode
|
|
132
136
|
* @permissionId Shoutout.Manage
|
|
137
|
+
* @permissionScope Manage Stores
|
|
138
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
133
139
|
* @permissionScope Access Verticals by Automations
|
|
134
140
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
135
141
|
* @permissionScope Set Up Automations
|
|
@@ -171,6 +177,8 @@ exports.verifyEmail = verifyEmail;
|
|
|
171
177
|
* @public
|
|
172
178
|
* @requiredField fromAddress
|
|
173
179
|
* @permissionId Shoutout.Manage
|
|
180
|
+
* @permissionScope Manage Stores
|
|
181
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
174
182
|
* @permissionScope Access Verticals by Automations
|
|
175
183
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
176
184
|
* @permissionScope Set Up Automations
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,uIAAyH;
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,uIAAyH;AA0MzH,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsFD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,gBAAgB;IAQpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAtCD,4CAsCC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,mBAAmB,CACvC,aAA4B;IAI5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,kDAqCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,WAAW,CAAC,gBAAwB;IACxD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAhCD,kCAgCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAInB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,4DAwCC"}
|
|
@@ -61,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
61
61
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
62
|
deletedEvent?: EntityDeletedEvent;
|
|
63
63
|
actionEvent?: ActionEvent;
|
|
64
|
-
/**
|
|
65
|
-
* Unique event ID.
|
|
66
|
-
* Allows clients to ignore duplicate webhooks.
|
|
67
|
-
*/
|
|
64
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
68
65
|
id?: string;
|
|
69
66
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
67
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
68
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
72
69
|
*/
|
|
73
70
|
entityFqdn?: string;
|
|
74
71
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
72
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
73
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
78
74
|
*/
|
|
79
75
|
slug?: string;
|
|
80
76
|
/** ID of the entity associated with the event. */
|
|
81
77
|
entityId?: string;
|
|
82
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
78
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
83
79
|
eventTime?: Date | null;
|
|
84
80
|
/**
|
|
85
81
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -89,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
89
85
|
/** If present, indicates the action that triggered the event. */
|
|
90
86
|
originatedFrom?: string | null;
|
|
91
87
|
/**
|
|
92
|
-
* A sequence number
|
|
93
|
-
*
|
|
94
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
95
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
96
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
97
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
88
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
89
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
98
90
|
*/
|
|
99
91
|
entityEventSequence?: string | null;
|
|
100
92
|
}
|
|
@@ -122,7 +114,7 @@ export interface EntityUpdatedEvent {
|
|
|
122
114
|
currentEntityAsJson?: string;
|
|
123
115
|
}
|
|
124
116
|
export interface EntityDeletedEvent {
|
|
125
|
-
/** Entity that was deleted */
|
|
117
|
+
/** Entity that was deleted. */
|
|
126
118
|
deletedEntityAsJson?: string | null;
|
|
127
119
|
}
|
|
128
120
|
export interface ActionEvent {
|
|
@@ -166,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
166
158
|
*/
|
|
167
159
|
appId?: string;
|
|
168
160
|
/** @readonly */
|
|
169
|
-
identityType?:
|
|
161
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
170
162
|
}
|
|
171
163
|
/** @oneof */
|
|
172
164
|
export interface IdentificationDataIdOneOf {
|
|
@@ -198,3 +190,5 @@ export declare enum WebhookIdentityType {
|
|
|
198
190
|
WIX_USER = "WIX_USER",
|
|
199
191
|
APP = "APP"
|
|
200
192
|
}
|
|
193
|
+
/** @enumType */
|
|
194
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":"AA0MA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
|
|
@@ -62,25 +62,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
62
62
|
updatedEvent?: EntityUpdatedEvent;
|
|
63
63
|
deletedEvent?: EntityDeletedEvent;
|
|
64
64
|
actionEvent?: ActionEvent;
|
|
65
|
-
/**
|
|
66
|
-
* Unique event ID.
|
|
67
|
-
* Allows clients to ignore duplicate webhooks.
|
|
68
|
-
*/
|
|
65
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
69
66
|
_id?: string;
|
|
70
67
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
68
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
69
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
73
70
|
*/
|
|
74
71
|
entityFqdn?: string;
|
|
75
72
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
73
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
74
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
79
75
|
*/
|
|
80
76
|
slug?: string;
|
|
81
77
|
/** ID of the entity associated with the event. */
|
|
82
78
|
entityId?: string;
|
|
83
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
79
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
84
80
|
eventTime?: Date | null;
|
|
85
81
|
/**
|
|
86
82
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -90,12 +86,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
90
86
|
/** If present, indicates the action that triggered the event. */
|
|
91
87
|
originatedFrom?: string | null;
|
|
92
88
|
/**
|
|
93
|
-
* A sequence number
|
|
94
|
-
*
|
|
95
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
96
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
97
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
98
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
89
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
90
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
99
91
|
*/
|
|
100
92
|
entityEventSequence?: string | null;
|
|
101
93
|
}
|
|
@@ -121,7 +113,7 @@ export interface EntityUpdatedEvent {
|
|
|
121
113
|
currentEntity?: string;
|
|
122
114
|
}
|
|
123
115
|
export interface EntityDeletedEvent {
|
|
124
|
-
/** Entity that was deleted */
|
|
116
|
+
/** Entity that was deleted. */
|
|
125
117
|
deletedEntity?: string | null;
|
|
126
118
|
}
|
|
127
119
|
export interface ActionEvent {
|
|
@@ -165,7 +157,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
165
157
|
*/
|
|
166
158
|
appId?: string;
|
|
167
159
|
/** @readonly */
|
|
168
|
-
identityType?:
|
|
160
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
169
161
|
}
|
|
170
162
|
/** @oneof */
|
|
171
163
|
export interface IdentificationDataIdOneOf {
|
|
@@ -197,6 +189,8 @@ export declare enum WebhookIdentityType {
|
|
|
197
189
|
WIX_USER = "WIX_USER",
|
|
198
190
|
APP = "APP"
|
|
199
191
|
}
|
|
192
|
+
/** @enumType */
|
|
193
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
200
194
|
export interface BaseEventMetadata {
|
|
201
195
|
/**
|
|
202
196
|
* App instance ID.
|
|
@@ -212,25 +206,21 @@ export interface BaseEventMetadata {
|
|
|
212
206
|
identity?: IdentificationData;
|
|
213
207
|
}
|
|
214
208
|
export interface EventMetadata extends BaseEventMetadata {
|
|
215
|
-
/**
|
|
216
|
-
* Unique event ID.
|
|
217
|
-
* Allows clients to ignore duplicate webhooks.
|
|
218
|
-
*/
|
|
209
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
219
210
|
_id?: string;
|
|
220
211
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
212
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
213
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
223
214
|
*/
|
|
224
215
|
entityFqdn?: string;
|
|
225
216
|
/**
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
217
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
218
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
229
219
|
*/
|
|
230
220
|
slug?: string;
|
|
231
221
|
/** ID of the entity associated with the event. */
|
|
232
222
|
entityId?: string;
|
|
233
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
223
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
234
224
|
eventTime?: Date | null;
|
|
235
225
|
/**
|
|
236
226
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -240,12 +230,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
240
230
|
/** If present, indicates the action that triggered the event. */
|
|
241
231
|
originatedFrom?: string | null;
|
|
242
232
|
/**
|
|
243
|
-
* A sequence number
|
|
244
|
-
*
|
|
245
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
246
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
247
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
248
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
233
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
234
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
249
235
|
*/
|
|
250
236
|
entityEventSequence?: string | null;
|
|
251
237
|
}
|
|
@@ -255,6 +241,8 @@ export interface SenderDetailsUpdatedEnvelope {
|
|
|
255
241
|
}
|
|
256
242
|
/**
|
|
257
243
|
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
244
|
+
* @permissionScope Manage Stores
|
|
245
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
258
246
|
* @permissionScope Access Verticals by Automations
|
|
259
247
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
260
248
|
* @permissionScope Set Up Automations
|
|
@@ -281,6 +269,8 @@ type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
|
|
|
281
269
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
282
270
|
* @public
|
|
283
271
|
* @permissionId Shoutout.Manage
|
|
272
|
+
* @permissionScope Manage Stores
|
|
273
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
284
274
|
* @permissionScope Access Verticals by Automations
|
|
285
275
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
286
276
|
* @permissionScope Set Up Automations
|
|
@@ -305,6 +295,8 @@ export declare function getSenderDetails(): Promise<NonNullablePaths<GetSenderDe
|
|
|
305
295
|
* @public
|
|
306
296
|
* @requiredField senderDetails
|
|
307
297
|
* @permissionId Shoutout.Manage
|
|
298
|
+
* @permissionScope Manage Stores
|
|
299
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
308
300
|
* @permissionScope Access Verticals by Automations
|
|
309
301
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
310
302
|
* @permissionScope Set Up Automations
|
|
@@ -324,6 +316,8 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
|
|
|
324
316
|
* @public
|
|
325
317
|
* @requiredField verificationCode
|
|
326
318
|
* @permissionId Shoutout.Manage
|
|
319
|
+
* @permissionScope Manage Stores
|
|
320
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
327
321
|
* @permissionScope Access Verticals by Automations
|
|
328
322
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
329
323
|
* @permissionScope Set Up Automations
|
|
@@ -343,6 +337,8 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
|
|
|
343
337
|
* @public
|
|
344
338
|
* @requiredField fromAddress
|
|
345
339
|
* @permissionId Shoutout.Manage
|
|
340
|
+
* @permissionScope Manage Stores
|
|
341
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
346
342
|
* @permissionScope Access Verticals by Automations
|
|
347
343
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
348
344
|
* @permissionScope Set Up Automations
|
|
@@ -19,6 +19,8 @@ export var WebhookIdentityType;
|
|
|
19
19
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
20
20
|
* @public
|
|
21
21
|
* @permissionId Shoutout.Manage
|
|
22
|
+
* @permissionScope Manage Stores
|
|
23
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
22
24
|
* @permissionScope Access Verticals by Automations
|
|
23
25
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
24
26
|
* @permissionScope Set Up Automations
|
|
@@ -61,6 +63,8 @@ export async function getSenderDetails() {
|
|
|
61
63
|
* @public
|
|
62
64
|
* @requiredField senderDetails
|
|
63
65
|
* @permissionId Shoutout.Manage
|
|
66
|
+
* @permissionScope Manage Stores
|
|
67
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
64
68
|
* @permissionScope Access Verticals by Automations
|
|
65
69
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
66
70
|
* @permissionScope Set Up Automations
|
|
@@ -102,6 +106,8 @@ export async function updateSenderDetails(senderDetails) {
|
|
|
102
106
|
* @public
|
|
103
107
|
* @requiredField verificationCode
|
|
104
108
|
* @permissionId Shoutout.Manage
|
|
109
|
+
* @permissionScope Manage Stores
|
|
110
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
105
111
|
* @permissionScope Access Verticals by Automations
|
|
106
112
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
107
113
|
* @permissionScope Set Up Automations
|
|
@@ -142,6 +148,8 @@ export async function verifyEmail(verificationCode) {
|
|
|
142
148
|
* @public
|
|
143
149
|
* @requiredField fromAddress
|
|
144
150
|
* @permissionId Shoutout.Manage
|
|
151
|
+
* @permissionScope Manage Stores
|
|
152
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
145
153
|
* @permissionScope Access Verticals by Automations
|
|
146
154
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
147
155
|
* @permissionScope Set Up Automations
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,0CAA0C,MAAM,4DAA4D,CAAC;
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,0CAA0C,MAAM,4DAA4D,CAAC;AA0MzH,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAsFD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IAQpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,aAA4B;IAI5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,gBAAwB;IACxD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAInB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
|
|
@@ -61,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
61
61
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
62
|
deletedEvent?: EntityDeletedEvent;
|
|
63
63
|
actionEvent?: ActionEvent;
|
|
64
|
-
/**
|
|
65
|
-
* Unique event ID.
|
|
66
|
-
* Allows clients to ignore duplicate webhooks.
|
|
67
|
-
*/
|
|
64
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
68
65
|
id?: string;
|
|
69
66
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
67
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
68
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
72
69
|
*/
|
|
73
70
|
entityFqdn?: string;
|
|
74
71
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
72
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
73
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
78
74
|
*/
|
|
79
75
|
slug?: string;
|
|
80
76
|
/** ID of the entity associated with the event. */
|
|
81
77
|
entityId?: string;
|
|
82
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
78
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
83
79
|
eventTime?: Date | null;
|
|
84
80
|
/**
|
|
85
81
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -89,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
89
85
|
/** If present, indicates the action that triggered the event. */
|
|
90
86
|
originatedFrom?: string | null;
|
|
91
87
|
/**
|
|
92
|
-
* A sequence number
|
|
93
|
-
*
|
|
94
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
95
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
96
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
97
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
88
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
89
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
98
90
|
*/
|
|
99
91
|
entityEventSequence?: string | null;
|
|
100
92
|
}
|
|
@@ -122,7 +114,7 @@ export interface EntityUpdatedEvent {
|
|
|
122
114
|
currentEntityAsJson?: string;
|
|
123
115
|
}
|
|
124
116
|
export interface EntityDeletedEvent {
|
|
125
|
-
/** Entity that was deleted */
|
|
117
|
+
/** Entity that was deleted. */
|
|
126
118
|
deletedEntityAsJson?: string | null;
|
|
127
119
|
}
|
|
128
120
|
export interface ActionEvent {
|
|
@@ -166,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
166
158
|
*/
|
|
167
159
|
appId?: string;
|
|
168
160
|
/** @readonly */
|
|
169
|
-
identityType?:
|
|
161
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
170
162
|
}
|
|
171
163
|
/** @oneof */
|
|
172
164
|
export interface IdentificationDataIdOneOf {
|
|
@@ -198,3 +190,5 @@ export declare enum WebhookIdentityType {
|
|
|
198
190
|
WIX_USER = "WIX_USER",
|
|
199
191
|
APP = "APP"
|
|
200
192
|
}
|
|
193
|
+
/** @enumType */
|
|
194
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":";;;AA0MA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts
CHANGED
|
@@ -62,25 +62,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
62
62
|
updatedEvent?: EntityUpdatedEvent;
|
|
63
63
|
deletedEvent?: EntityDeletedEvent;
|
|
64
64
|
actionEvent?: ActionEvent;
|
|
65
|
-
/**
|
|
66
|
-
* Unique event ID.
|
|
67
|
-
* Allows clients to ignore duplicate webhooks.
|
|
68
|
-
*/
|
|
65
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
69
66
|
_id?: string;
|
|
70
67
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
68
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
69
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
73
70
|
*/
|
|
74
71
|
entityFqdn?: string;
|
|
75
72
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
73
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
74
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
79
75
|
*/
|
|
80
76
|
slug?: string;
|
|
81
77
|
/** ID of the entity associated with the event. */
|
|
82
78
|
entityId?: string;
|
|
83
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
79
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
84
80
|
eventTime?: Date | null;
|
|
85
81
|
/**
|
|
86
82
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -90,12 +86,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
90
86
|
/** If present, indicates the action that triggered the event. */
|
|
91
87
|
originatedFrom?: string | null;
|
|
92
88
|
/**
|
|
93
|
-
* A sequence number
|
|
94
|
-
*
|
|
95
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
96
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
97
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
98
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
89
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
90
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
99
91
|
*/
|
|
100
92
|
entityEventSequence?: string | null;
|
|
101
93
|
}
|
|
@@ -121,7 +113,7 @@ export interface EntityUpdatedEvent {
|
|
|
121
113
|
currentEntity?: string;
|
|
122
114
|
}
|
|
123
115
|
export interface EntityDeletedEvent {
|
|
124
|
-
/** Entity that was deleted */
|
|
116
|
+
/** Entity that was deleted. */
|
|
125
117
|
deletedEntity?: string | null;
|
|
126
118
|
}
|
|
127
119
|
export interface ActionEvent {
|
|
@@ -165,7 +157,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
165
157
|
*/
|
|
166
158
|
appId?: string;
|
|
167
159
|
/** @readonly */
|
|
168
|
-
identityType?:
|
|
160
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
169
161
|
}
|
|
170
162
|
/** @oneof */
|
|
171
163
|
export interface IdentificationDataIdOneOf {
|
|
@@ -197,6 +189,8 @@ export declare enum WebhookIdentityType {
|
|
|
197
189
|
WIX_USER = "WIX_USER",
|
|
198
190
|
APP = "APP"
|
|
199
191
|
}
|
|
192
|
+
/** @enumType */
|
|
193
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
200
194
|
export interface BaseEventMetadata {
|
|
201
195
|
/**
|
|
202
196
|
* App instance ID.
|
|
@@ -212,25 +206,21 @@ export interface BaseEventMetadata {
|
|
|
212
206
|
identity?: IdentificationData;
|
|
213
207
|
}
|
|
214
208
|
export interface EventMetadata extends BaseEventMetadata {
|
|
215
|
-
/**
|
|
216
|
-
* Unique event ID.
|
|
217
|
-
* Allows clients to ignore duplicate webhooks.
|
|
218
|
-
*/
|
|
209
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
219
210
|
_id?: string;
|
|
220
211
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
212
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
213
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
223
214
|
*/
|
|
224
215
|
entityFqdn?: string;
|
|
225
216
|
/**
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
217
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
218
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
229
219
|
*/
|
|
230
220
|
slug?: string;
|
|
231
221
|
/** ID of the entity associated with the event. */
|
|
232
222
|
entityId?: string;
|
|
233
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
223
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
234
224
|
eventTime?: Date | null;
|
|
235
225
|
/**
|
|
236
226
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -240,12 +230,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
240
230
|
/** If present, indicates the action that triggered the event. */
|
|
241
231
|
originatedFrom?: string | null;
|
|
242
232
|
/**
|
|
243
|
-
* A sequence number
|
|
244
|
-
*
|
|
245
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
246
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
247
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
248
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
233
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
234
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
249
235
|
*/
|
|
250
236
|
entityEventSequence?: string | null;
|
|
251
237
|
}
|
|
@@ -255,6 +241,8 @@ export interface SenderDetailsUpdatedEnvelope {
|
|
|
255
241
|
}
|
|
256
242
|
/**
|
|
257
243
|
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
244
|
+
* @permissionScope Manage Stores
|
|
245
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
258
246
|
* @permissionScope Access Verticals by Automations
|
|
259
247
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
260
248
|
* @permissionScope Set Up Automations
|
|
@@ -281,6 +269,8 @@ type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
|
|
|
281
269
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
282
270
|
* @public
|
|
283
271
|
* @permissionId Shoutout.Manage
|
|
272
|
+
* @permissionScope Manage Stores
|
|
273
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
284
274
|
* @permissionScope Access Verticals by Automations
|
|
285
275
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
286
276
|
* @permissionScope Set Up Automations
|
|
@@ -305,6 +295,8 @@ export declare function getSenderDetails(): Promise<NonNullablePaths<GetSenderDe
|
|
|
305
295
|
* @public
|
|
306
296
|
* @requiredField senderDetails
|
|
307
297
|
* @permissionId Shoutout.Manage
|
|
298
|
+
* @permissionScope Manage Stores
|
|
299
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
308
300
|
* @permissionScope Access Verticals by Automations
|
|
309
301
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
310
302
|
* @permissionScope Set Up Automations
|
|
@@ -324,6 +316,8 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
|
|
|
324
316
|
* @public
|
|
325
317
|
* @requiredField verificationCode
|
|
326
318
|
* @permissionId Shoutout.Manage
|
|
319
|
+
* @permissionScope Manage Stores
|
|
320
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
327
321
|
* @permissionScope Access Verticals by Automations
|
|
328
322
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
329
323
|
* @permissionScope Set Up Automations
|
|
@@ -343,6 +337,8 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
|
|
|
343
337
|
* @public
|
|
344
338
|
* @requiredField fromAddress
|
|
345
339
|
* @permissionId Shoutout.Manage
|
|
340
|
+
* @permissionScope Manage Stores
|
|
341
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
346
342
|
* @permissionScope Access Verticals by Automations
|
|
347
343
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
348
344
|
* @permissionScope Set Up Automations
|
package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js
CHANGED
|
@@ -45,6 +45,8 @@ var WebhookIdentityType;
|
|
|
45
45
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
46
46
|
* @public
|
|
47
47
|
* @permissionId Shoutout.Manage
|
|
48
|
+
* @permissionScope Manage Stores
|
|
49
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
48
50
|
* @permissionScope Access Verticals by Automations
|
|
49
51
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
50
52
|
* @permissionScope Set Up Automations
|
|
@@ -88,6 +90,8 @@ exports.getSenderDetails = getSenderDetails;
|
|
|
88
90
|
* @public
|
|
89
91
|
* @requiredField senderDetails
|
|
90
92
|
* @permissionId Shoutout.Manage
|
|
93
|
+
* @permissionScope Manage Stores
|
|
94
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
91
95
|
* @permissionScope Access Verticals by Automations
|
|
92
96
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
93
97
|
* @permissionScope Set Up Automations
|
|
@@ -130,6 +134,8 @@ exports.updateSenderDetails = updateSenderDetails;
|
|
|
130
134
|
* @public
|
|
131
135
|
* @requiredField verificationCode
|
|
132
136
|
* @permissionId Shoutout.Manage
|
|
137
|
+
* @permissionScope Manage Stores
|
|
138
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
133
139
|
* @permissionScope Access Verticals by Automations
|
|
134
140
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
135
141
|
* @permissionScope Set Up Automations
|
|
@@ -171,6 +177,8 @@ exports.verifyEmail = verifyEmail;
|
|
|
171
177
|
* @public
|
|
172
178
|
* @requiredField fromAddress
|
|
173
179
|
* @permissionId Shoutout.Manage
|
|
180
|
+
* @permissionScope Manage Stores
|
|
181
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
174
182
|
* @permissionScope Access Verticals by Automations
|
|
175
183
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
176
184
|
* @permissionScope Set Up Automations
|
package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,uIAAyH;
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,uIAAyH;AA0MzH,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsFD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,gBAAgB;IAQpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAtCD,4CAsCC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,mBAAmB,CACvC,aAA4B;IAI5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,kDAqCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,WAAW,CAAC,gBAAwB;IACxD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAhCD,kCAgCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAInB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,4DAwCC"}
|
|
@@ -61,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
61
61
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
62
|
deletedEvent?: EntityDeletedEvent;
|
|
63
63
|
actionEvent?: ActionEvent;
|
|
64
|
-
/**
|
|
65
|
-
* Unique event ID.
|
|
66
|
-
* Allows clients to ignore duplicate webhooks.
|
|
67
|
-
*/
|
|
64
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
68
65
|
id?: string;
|
|
69
66
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
67
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
68
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
72
69
|
*/
|
|
73
70
|
entityFqdn?: string;
|
|
74
71
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
72
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
73
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
78
74
|
*/
|
|
79
75
|
slug?: string;
|
|
80
76
|
/** ID of the entity associated with the event. */
|
|
81
77
|
entityId?: string;
|
|
82
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
78
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
83
79
|
eventTime?: Date | null;
|
|
84
80
|
/**
|
|
85
81
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -89,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
89
85
|
/** If present, indicates the action that triggered the event. */
|
|
90
86
|
originatedFrom?: string | null;
|
|
91
87
|
/**
|
|
92
|
-
* A sequence number
|
|
93
|
-
*
|
|
94
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
95
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
96
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
97
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
88
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
89
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
98
90
|
*/
|
|
99
91
|
entityEventSequence?: string | null;
|
|
100
92
|
}
|
|
@@ -122,7 +114,7 @@ export interface EntityUpdatedEvent {
|
|
|
122
114
|
currentEntityAsJson?: string;
|
|
123
115
|
}
|
|
124
116
|
export interface EntityDeletedEvent {
|
|
125
|
-
/** Entity that was deleted */
|
|
117
|
+
/** Entity that was deleted. */
|
|
126
118
|
deletedEntityAsJson?: string | null;
|
|
127
119
|
}
|
|
128
120
|
export interface ActionEvent {
|
|
@@ -166,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
166
158
|
*/
|
|
167
159
|
appId?: string;
|
|
168
160
|
/** @readonly */
|
|
169
|
-
identityType?:
|
|
161
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
170
162
|
}
|
|
171
163
|
/** @oneof */
|
|
172
164
|
export interface IdentificationDataIdOneOf {
|
|
@@ -198,3 +190,5 @@ export declare enum WebhookIdentityType {
|
|
|
198
190
|
WIX_USER = "WIX_USER",
|
|
199
191
|
APP = "APP"
|
|
200
192
|
}
|
|
193
|
+
/** @enumType */
|
|
194
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.types.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.types.ts"],"names":[],"mappings":"AA0MA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
|
package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts
CHANGED
|
@@ -62,25 +62,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
62
62
|
updatedEvent?: EntityUpdatedEvent;
|
|
63
63
|
deletedEvent?: EntityDeletedEvent;
|
|
64
64
|
actionEvent?: ActionEvent;
|
|
65
|
-
/**
|
|
66
|
-
* Unique event ID.
|
|
67
|
-
* Allows clients to ignore duplicate webhooks.
|
|
68
|
-
*/
|
|
65
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
69
66
|
_id?: string;
|
|
70
67
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
68
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
69
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
73
70
|
*/
|
|
74
71
|
entityFqdn?: string;
|
|
75
72
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
73
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
74
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
79
75
|
*/
|
|
80
76
|
slug?: string;
|
|
81
77
|
/** ID of the entity associated with the event. */
|
|
82
78
|
entityId?: string;
|
|
83
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
79
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
84
80
|
eventTime?: Date | null;
|
|
85
81
|
/**
|
|
86
82
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -90,12 +86,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
90
86
|
/** If present, indicates the action that triggered the event. */
|
|
91
87
|
originatedFrom?: string | null;
|
|
92
88
|
/**
|
|
93
|
-
* A sequence number
|
|
94
|
-
*
|
|
95
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
96
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
97
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
98
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
89
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
90
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
99
91
|
*/
|
|
100
92
|
entityEventSequence?: string | null;
|
|
101
93
|
}
|
|
@@ -121,7 +113,7 @@ export interface EntityUpdatedEvent {
|
|
|
121
113
|
currentEntity?: string;
|
|
122
114
|
}
|
|
123
115
|
export interface EntityDeletedEvent {
|
|
124
|
-
/** Entity that was deleted */
|
|
116
|
+
/** Entity that was deleted. */
|
|
125
117
|
deletedEntity?: string | null;
|
|
126
118
|
}
|
|
127
119
|
export interface ActionEvent {
|
|
@@ -165,7 +157,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
165
157
|
*/
|
|
166
158
|
appId?: string;
|
|
167
159
|
/** @readonly */
|
|
168
|
-
identityType?:
|
|
160
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
169
161
|
}
|
|
170
162
|
/** @oneof */
|
|
171
163
|
export interface IdentificationDataIdOneOf {
|
|
@@ -197,6 +189,8 @@ export declare enum WebhookIdentityType {
|
|
|
197
189
|
WIX_USER = "WIX_USER",
|
|
198
190
|
APP = "APP"
|
|
199
191
|
}
|
|
192
|
+
/** @enumType */
|
|
193
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
200
194
|
export interface BaseEventMetadata {
|
|
201
195
|
/**
|
|
202
196
|
* App instance ID.
|
|
@@ -212,25 +206,21 @@ export interface BaseEventMetadata {
|
|
|
212
206
|
identity?: IdentificationData;
|
|
213
207
|
}
|
|
214
208
|
export interface EventMetadata extends BaseEventMetadata {
|
|
215
|
-
/**
|
|
216
|
-
* Unique event ID.
|
|
217
|
-
* Allows clients to ignore duplicate webhooks.
|
|
218
|
-
*/
|
|
209
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
219
210
|
_id?: string;
|
|
220
211
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
212
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
213
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
223
214
|
*/
|
|
224
215
|
entityFqdn?: string;
|
|
225
216
|
/**
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
217
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
218
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
229
219
|
*/
|
|
230
220
|
slug?: string;
|
|
231
221
|
/** ID of the entity associated with the event. */
|
|
232
222
|
entityId?: string;
|
|
233
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
223
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
234
224
|
eventTime?: Date | null;
|
|
235
225
|
/**
|
|
236
226
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -240,12 +230,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
240
230
|
/** If present, indicates the action that triggered the event. */
|
|
241
231
|
originatedFrom?: string | null;
|
|
242
232
|
/**
|
|
243
|
-
* A sequence number
|
|
244
|
-
*
|
|
245
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
246
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
247
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
248
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
233
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
234
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
249
235
|
*/
|
|
250
236
|
entityEventSequence?: string | null;
|
|
251
237
|
}
|
|
@@ -255,6 +241,8 @@ export interface SenderDetailsUpdatedEnvelope {
|
|
|
255
241
|
}
|
|
256
242
|
/**
|
|
257
243
|
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
244
|
+
* @permissionScope Manage Stores
|
|
245
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
258
246
|
* @permissionScope Access Verticals by Automations
|
|
259
247
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
260
248
|
* @permissionScope Set Up Automations
|
|
@@ -281,6 +269,8 @@ type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
|
|
|
281
269
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
282
270
|
* @public
|
|
283
271
|
* @permissionId Shoutout.Manage
|
|
272
|
+
* @permissionScope Manage Stores
|
|
273
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
284
274
|
* @permissionScope Access Verticals by Automations
|
|
285
275
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
286
276
|
* @permissionScope Set Up Automations
|
|
@@ -305,6 +295,8 @@ export declare function getSenderDetails(): Promise<NonNullablePaths<GetSenderDe
|
|
|
305
295
|
* @public
|
|
306
296
|
* @requiredField senderDetails
|
|
307
297
|
* @permissionId Shoutout.Manage
|
|
298
|
+
* @permissionScope Manage Stores
|
|
299
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
308
300
|
* @permissionScope Access Verticals by Automations
|
|
309
301
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
310
302
|
* @permissionScope Set Up Automations
|
|
@@ -324,6 +316,8 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
|
|
|
324
316
|
* @public
|
|
325
317
|
* @requiredField verificationCode
|
|
326
318
|
* @permissionId Shoutout.Manage
|
|
319
|
+
* @permissionScope Manage Stores
|
|
320
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
327
321
|
* @permissionScope Access Verticals by Automations
|
|
328
322
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
329
323
|
* @permissionScope Set Up Automations
|
|
@@ -343,6 +337,8 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
|
|
|
343
337
|
* @public
|
|
344
338
|
* @requiredField fromAddress
|
|
345
339
|
* @permissionId Shoutout.Manage
|
|
340
|
+
* @permissionScope Manage Stores
|
|
341
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
346
342
|
* @permissionScope Access Verticals by Automations
|
|
347
343
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
348
344
|
* @permissionScope Set Up Automations
|
|
@@ -19,6 +19,8 @@ export var WebhookIdentityType;
|
|
|
19
19
|
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
20
20
|
* @public
|
|
21
21
|
* @permissionId Shoutout.Manage
|
|
22
|
+
* @permissionScope Manage Stores
|
|
23
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
22
24
|
* @permissionScope Access Verticals by Automations
|
|
23
25
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
24
26
|
* @permissionScope Set Up Automations
|
|
@@ -61,6 +63,8 @@ export async function getSenderDetails() {
|
|
|
61
63
|
* @public
|
|
62
64
|
* @requiredField senderDetails
|
|
63
65
|
* @permissionId Shoutout.Manage
|
|
66
|
+
* @permissionScope Manage Stores
|
|
67
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
64
68
|
* @permissionScope Access Verticals by Automations
|
|
65
69
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
66
70
|
* @permissionScope Set Up Automations
|
|
@@ -102,6 +106,8 @@ export async function updateSenderDetails(senderDetails) {
|
|
|
102
106
|
* @public
|
|
103
107
|
* @requiredField verificationCode
|
|
104
108
|
* @permissionId Shoutout.Manage
|
|
109
|
+
* @permissionScope Manage Stores
|
|
110
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
105
111
|
* @permissionScope Access Verticals by Automations
|
|
106
112
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
107
113
|
* @permissionScope Set Up Automations
|
|
@@ -142,6 +148,8 @@ export async function verifyEmail(verificationCode) {
|
|
|
142
148
|
* @public
|
|
143
149
|
* @requiredField fromAddress
|
|
144
150
|
* @permissionId Shoutout.Manage
|
|
151
|
+
* @permissionScope Manage Stores
|
|
152
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
145
153
|
* @permissionScope Access Verticals by Automations
|
|
146
154
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
147
155
|
* @permissionScope Set Up Automations
|
package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,0CAA0C,MAAM,4DAA4D,CAAC;
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.universal.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,0CAA0C,MAAM,4DAA4D,CAAC;AA0MzH,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAsFD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IAQpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,aAA4B;IAI5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,gBAAwB;IACxD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAInB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_email-marketing_sender-details",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"service-plugins"
|
|
29
29
|
],
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@wix/sdk-runtime": "^0.3.
|
|
32
|
-
"@wix/sdk-types": "^1.13.
|
|
31
|
+
"@wix/sdk-runtime": "^0.3.49",
|
|
32
|
+
"@wix/sdk-types": "^1.13.23"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"typescript": "^5.3.2"
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": "wix.email_marketing.v1.sender_details"
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "b399a76c534f97fa600ada089a99613f29f0c1146b62058206971c47"
|
|
52
52
|
}
|