@wix/auto_sdk_email-marketing_sender-details 1.0.0 → 1.0.2

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 (21) hide show
  1. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +52 -13
  2. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
  3. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +82 -15
  4. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +16 -0
  5. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
  6. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +52 -13
  7. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
  8. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +82 -15
  9. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js +16 -0
  10. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
  11. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +52 -13
  12. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
  13. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +82 -15
  14. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +16 -0
  15. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
  16. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +52 -13
  17. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -1
  18. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +82 -15
  19. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js +16 -0
  20. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -1
  21. package/package.json +2 -2
@@ -11,7 +11,10 @@
11
11
  export interface SenderDetails {
12
12
  /** Display name of sender. */
13
13
  fromName?: string;
14
- /** Email address of sender. */
14
+ /**
15
+ * Email address of sender.
16
+ * @format EMAIL
17
+ */
15
18
  fromEmail?: string;
16
19
  /**
17
20
  * Date and time the sender's email address was verified.
@@ -40,11 +43,17 @@ export interface VerifySenderEmailRequest {
40
43
  export interface VerifySenderEmailResponse {
41
44
  }
42
45
  export interface ResolveActualFromAddressRequest {
43
- /** User's provided address from which to send email marketing campaign. */
46
+ /**
47
+ * User's provided address from which to send email marketing campaign.
48
+ * @format EMAIL
49
+ */
44
50
  fromAddress: string;
45
51
  }
46
52
  export interface ResolveActualFromAddressResponse {
47
- /** Actual from-address that will be used for email distribution. */
53
+ /**
54
+ * Actual from-address that will be used for email distribution.
55
+ * @format EMAIL
56
+ */
48
57
  actualFromAddress?: string;
49
58
  }
50
59
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -120,9 +129,15 @@ export interface ActionEvent {
120
129
  bodyAsJson?: string;
121
130
  }
122
131
  export interface MessageEnvelope {
123
- /** App instance ID. */
132
+ /**
133
+ * App instance ID.
134
+ * @format GUID
135
+ */
124
136
  instanceId?: string | null;
125
- /** Event type. */
137
+ /**
138
+ * Event type.
139
+ * @maxLength 150
140
+ */
126
141
  eventType?: string;
127
142
  /** The identification type and identity data. */
128
143
  identity?: IdentificationData;
@@ -130,26 +145,50 @@ export interface MessageEnvelope {
130
145
  data?: string;
131
146
  }
132
147
  export interface IdentificationData extends IdentificationDataIdOneOf {
133
- /** ID of a site visitor that has not logged in to the site. */
148
+ /**
149
+ * ID of a site visitor that has not logged in to the site.
150
+ * @format GUID
151
+ */
134
152
  anonymousVisitorId?: string;
135
- /** ID of a site visitor that has logged in to the site. */
153
+ /**
154
+ * ID of a site visitor that has logged in to the site.
155
+ * @format GUID
156
+ */
136
157
  memberId?: string;
137
- /** ID of a Wix user (site owner, contributor, etc.). */
158
+ /**
159
+ * ID of a Wix user (site owner, contributor, etc.).
160
+ * @format GUID
161
+ */
138
162
  wixUserId?: string;
139
- /** ID of an app. */
163
+ /**
164
+ * ID of an app.
165
+ * @format GUID
166
+ */
140
167
  appId?: string;
141
168
  /** @readonly */
142
169
  identityType?: WebhookIdentityType;
143
170
  }
144
171
  /** @oneof */
145
172
  export interface IdentificationDataIdOneOf {
146
- /** ID of a site visitor that has not logged in to the site. */
173
+ /**
174
+ * ID of a site visitor that has not logged in to the site.
175
+ * @format GUID
176
+ */
147
177
  anonymousVisitorId?: string;
148
- /** ID of a site visitor that has logged in to the site. */
178
+ /**
179
+ * ID of a site visitor that has logged in to the site.
180
+ * @format GUID
181
+ */
149
182
  memberId?: string;
150
- /** ID of a Wix user (site owner, contributor, etc.). */
183
+ /**
184
+ * ID of a Wix user (site owner, contributor, etc.).
185
+ * @format GUID
186
+ */
151
187
  wixUserId?: string;
152
- /** ID of an app. */
188
+ /**
189
+ * ID of an app.
190
+ * @format GUID
191
+ */
153
192
  appId?: string;
154
193
  }
155
194
  export declare enum WebhookIdentityType {
@@ -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":";;;AA2KA,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"}
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":";;;AAkNA,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"}
@@ -11,7 +11,10 @@
11
11
  export interface SenderDetails {
12
12
  /** Display name of sender. */
13
13
  fromName?: string;
14
- /** Email address of sender. */
14
+ /**
15
+ * Email address of sender.
16
+ * @format EMAIL
17
+ */
15
18
  fromEmail?: string;
16
19
  /**
17
20
  * Date and time the sender's email address was verified.
@@ -40,11 +43,17 @@ export interface VerifySenderEmailRequest {
40
43
  export interface VerifySenderEmailResponse {
41
44
  }
42
45
  export interface ResolveActualFromAddressRequest {
43
- /** User's provided address from which to send email marketing campaign. */
46
+ /**
47
+ * User's provided address from which to send email marketing campaign.
48
+ * @format EMAIL
49
+ */
44
50
  fromAddress: string;
45
51
  }
46
52
  export interface ResolveActualFromAddressResponse {
47
- /** Actual from-address that will be used for email distribution. */
53
+ /**
54
+ * Actual from-address that will be used for email distribution.
55
+ * @format EMAIL
56
+ */
48
57
  actualFromAddress?: string;
49
58
  }
50
59
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -118,9 +127,15 @@ export interface ActionEvent {
118
127
  body?: string;
119
128
  }
120
129
  export interface MessageEnvelope {
121
- /** App instance ID. */
130
+ /**
131
+ * App instance ID.
132
+ * @format GUID
133
+ */
122
134
  instanceId?: string | null;
123
- /** Event type. */
135
+ /**
136
+ * Event type.
137
+ * @maxLength 150
138
+ */
124
139
  eventType?: string;
125
140
  /** The identification type and identity data. */
126
141
  identity?: IdentificationData;
@@ -128,26 +143,50 @@ export interface MessageEnvelope {
128
143
  data?: string;
129
144
  }
130
145
  export interface IdentificationData extends IdentificationDataIdOneOf {
131
- /** ID of a site visitor that has not logged in to the site. */
146
+ /**
147
+ * ID of a site visitor that has not logged in to the site.
148
+ * @format GUID
149
+ */
132
150
  anonymousVisitorId?: string;
133
- /** ID of a site visitor that has logged in to the site. */
151
+ /**
152
+ * ID of a site visitor that has logged in to the site.
153
+ * @format GUID
154
+ */
134
155
  memberId?: string;
135
- /** ID of a Wix user (site owner, contributor, etc.). */
156
+ /**
157
+ * ID of a Wix user (site owner, contributor, etc.).
158
+ * @format GUID
159
+ */
136
160
  wixUserId?: string;
137
- /** ID of an app. */
161
+ /**
162
+ * ID of an app.
163
+ * @format GUID
164
+ */
138
165
  appId?: string;
139
166
  /** @readonly */
140
167
  identityType?: WebhookIdentityType;
141
168
  }
142
169
  /** @oneof */
143
170
  export interface IdentificationDataIdOneOf {
144
- /** ID of a site visitor that has not logged in to the site. */
171
+ /**
172
+ * ID of a site visitor that has not logged in to the site.
173
+ * @format GUID
174
+ */
145
175
  anonymousVisitorId?: string;
146
- /** ID of a site visitor that has logged in to the site. */
176
+ /**
177
+ * ID of a site visitor that has logged in to the site.
178
+ * @format GUID
179
+ */
147
180
  memberId?: string;
148
- /** ID of a Wix user (site owner, contributor, etc.). */
181
+ /**
182
+ * ID of a Wix user (site owner, contributor, etc.).
183
+ * @format GUID
184
+ */
149
185
  wixUserId?: string;
150
- /** ID of an app. */
186
+ /**
187
+ * ID of an app.
188
+ * @format GUID
189
+ */
151
190
  appId?: string;
152
191
  }
153
192
  export declare enum WebhookIdentityType {
@@ -171,9 +210,15 @@ export interface ResolveActualFromAddressResponseNonNullableFields {
171
210
  actualFromAddress: string;
172
211
  }
173
212
  export interface BaseEventMetadata {
174
- /** App instance ID. */
213
+ /**
214
+ * App instance ID.
215
+ * @format GUID
216
+ */
175
217
  instanceId?: string | null;
176
- /** Event type. */
218
+ /**
219
+ * Event type.
220
+ * @maxLength 150
221
+ */
177
222
  eventType?: string;
178
223
  /** The identification type and identity data. */
179
224
  identity?: IdentificationData;
@@ -222,6 +267,10 @@ export interface SenderDetailsUpdatedEnvelope {
222
267
  }
223
268
  /**
224
269
  * An event that triggers when sender details are updated without the need for explicit verification.
270
+ * @permissionScope Access Verticals by Automations
271
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
272
+ * @permissionScope Set Up Automations
273
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
225
274
  * @permissionScope Read Email Marketing
226
275
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
227
276
  * @permissionScope Manage Email Marketing
@@ -229,6 +278,8 @@ export interface SenderDetailsUpdatedEnvelope {
229
278
  * @permissionId Shoutout.Read
230
279
  * @webhook
231
280
  * @eventType wix.email_marketing.v1.sender_details_updated
281
+ * @serviceIdentifier wix.emailmarketing.api.v1.SenderDetailsService
282
+ * @slug updated
232
283
  */
233
284
  export declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpdatedEnvelope) => void | Promise<void>): void;
234
285
  /**
@@ -243,6 +294,10 @@ export declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpd
243
294
  * + 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.
244
295
  * @public
245
296
  * @permissionId Shoutout.Manage
297
+ * @permissionScope Access Verticals by Automations
298
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
299
+ * @permissionScope Set Up Automations
300
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
246
301
  * @permissionScope Manage Email Marketing
247
302
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
248
303
  * @applicableIdentity APP
@@ -263,6 +318,10 @@ export declare function getSenderDetails(): Promise<GetSenderDetailsResponse & G
263
318
  * @public
264
319
  * @requiredField senderDetails
265
320
  * @permissionId Shoutout.Manage
321
+ * @permissionScope Access Verticals by Automations
322
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
323
+ * @permissionScope Set Up Automations
324
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
266
325
  * @permissionScope Manage Email Marketing
267
326
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
268
327
  * @applicableIdentity APP
@@ -278,6 +337,10 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
278
337
  * @public
279
338
  * @requiredField verificationCode
280
339
  * @permissionId Shoutout.Manage
340
+ * @permissionScope Access Verticals by Automations
341
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
342
+ * @permissionScope Set Up Automations
343
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
281
344
  * @permissionScope Manage Email Marketing
282
345
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
283
346
  * @applicableIdentity APP
@@ -293,6 +356,10 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
293
356
  * @public
294
357
  * @requiredField fromAddress
295
358
  * @permissionId Shoutout.Manage
359
+ * @permissionScope Access Verticals by Automations
360
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
361
+ * @permissionScope Set Up Automations
362
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
296
363
  * @permissionScope Manage Email Marketing
297
364
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
298
365
  * @applicableIdentity APP
@@ -47,6 +47,10 @@ var WebhookIdentityType;
47
47
  * + 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.
48
48
  * @public
49
49
  * @permissionId Shoutout.Manage
50
+ * @permissionScope Access Verticals by Automations
51
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
52
+ * @permissionScope Set Up Automations
53
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
50
54
  * @permissionScope Manage Email Marketing
51
55
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
52
56
  * @applicableIdentity APP
@@ -88,6 +92,10 @@ exports.getSenderDetails = getSenderDetails;
88
92
  * @public
89
93
  * @requiredField senderDetails
90
94
  * @permissionId Shoutout.Manage
95
+ * @permissionScope Access Verticals by Automations
96
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
97
+ * @permissionScope Set Up Automations
98
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
91
99
  * @permissionScope Manage Email Marketing
92
100
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
93
101
  * @applicableIdentity APP
@@ -126,6 +134,10 @@ exports.updateSenderDetails = updateSenderDetails;
126
134
  * @public
127
135
  * @requiredField verificationCode
128
136
  * @permissionId Shoutout.Manage
137
+ * @permissionScope Access Verticals by Automations
138
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
139
+ * @permissionScope Set Up Automations
140
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
129
141
  * @permissionScope Manage Email Marketing
130
142
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
131
143
  * @applicableIdentity APP
@@ -163,6 +175,10 @@ exports.verifyEmail = verifyEmail;
163
175
  * @public
164
176
  * @requiredField fromAddress
165
177
  * @permissionId Shoutout.Manage
178
+ * @permissionScope Access Verticals by Automations
179
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
180
+ * @permissionScope Set Up Automations
181
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
166
182
  * @permissionScope Manage Email Marketing
167
183
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
168
184
  * @applicableIdentity APP
@@ -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;AA2KzH,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;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,gBAAgB;IAGpC,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;AAjCD,4CAiCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;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;;;;;;;;;;;;;GAaG;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;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAKnB,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;AAzCD,4DAyCC"}
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;AAkNzH,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;AAkGD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,gBAAgB;IAGpC,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;AAjCD,4CAiCC;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;;;;;;;;;;;;;;;;;GAiBG;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;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAKnB,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;AAzCD,4DAyCC"}
@@ -11,7 +11,10 @@
11
11
  export interface SenderDetails {
12
12
  /** Display name of sender. */
13
13
  fromName?: string;
14
- /** Email address of sender. */
14
+ /**
15
+ * Email address of sender.
16
+ * @format EMAIL
17
+ */
15
18
  fromEmail?: string;
16
19
  /**
17
20
  * Date and time the sender's email address was verified.
@@ -40,11 +43,17 @@ export interface VerifySenderEmailRequest {
40
43
  export interface VerifySenderEmailResponse {
41
44
  }
42
45
  export interface ResolveActualFromAddressRequest {
43
- /** User's provided address from which to send email marketing campaign. */
46
+ /**
47
+ * User's provided address from which to send email marketing campaign.
48
+ * @format EMAIL
49
+ */
44
50
  fromAddress: string;
45
51
  }
46
52
  export interface ResolveActualFromAddressResponse {
47
- /** Actual from-address that will be used for email distribution. */
53
+ /**
54
+ * Actual from-address that will be used for email distribution.
55
+ * @format EMAIL
56
+ */
48
57
  actualFromAddress?: string;
49
58
  }
50
59
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -120,9 +129,15 @@ export interface ActionEvent {
120
129
  bodyAsJson?: string;
121
130
  }
122
131
  export interface MessageEnvelope {
123
- /** App instance ID. */
132
+ /**
133
+ * App instance ID.
134
+ * @format GUID
135
+ */
124
136
  instanceId?: string | null;
125
- /** Event type. */
137
+ /**
138
+ * Event type.
139
+ * @maxLength 150
140
+ */
126
141
  eventType?: string;
127
142
  /** The identification type and identity data. */
128
143
  identity?: IdentificationData;
@@ -130,26 +145,50 @@ export interface MessageEnvelope {
130
145
  data?: string;
131
146
  }
132
147
  export interface IdentificationData extends IdentificationDataIdOneOf {
133
- /** ID of a site visitor that has not logged in to the site. */
148
+ /**
149
+ * ID of a site visitor that has not logged in to the site.
150
+ * @format GUID
151
+ */
134
152
  anonymousVisitorId?: string;
135
- /** ID of a site visitor that has logged in to the site. */
153
+ /**
154
+ * ID of a site visitor that has logged in to the site.
155
+ * @format GUID
156
+ */
136
157
  memberId?: string;
137
- /** ID of a Wix user (site owner, contributor, etc.). */
158
+ /**
159
+ * ID of a Wix user (site owner, contributor, etc.).
160
+ * @format GUID
161
+ */
138
162
  wixUserId?: string;
139
- /** ID of an app. */
163
+ /**
164
+ * ID of an app.
165
+ * @format GUID
166
+ */
140
167
  appId?: string;
141
168
  /** @readonly */
142
169
  identityType?: WebhookIdentityType;
143
170
  }
144
171
  /** @oneof */
145
172
  export interface IdentificationDataIdOneOf {
146
- /** ID of a site visitor that has not logged in to the site. */
173
+ /**
174
+ * ID of a site visitor that has not logged in to the site.
175
+ * @format GUID
176
+ */
147
177
  anonymousVisitorId?: string;
148
- /** ID of a site visitor that has logged in to the site. */
178
+ /**
179
+ * ID of a site visitor that has logged in to the site.
180
+ * @format GUID
181
+ */
149
182
  memberId?: string;
150
- /** ID of a Wix user (site owner, contributor, etc.). */
183
+ /**
184
+ * ID of a Wix user (site owner, contributor, etc.).
185
+ * @format GUID
186
+ */
151
187
  wixUserId?: string;
152
- /** ID of an app. */
188
+ /**
189
+ * ID of an app.
190
+ * @format GUID
191
+ */
153
192
  appId?: string;
154
193
  }
155
194
  export declare enum WebhookIdentityType {
@@ -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":"AA2KA,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"}
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":"AAkNA,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"}
@@ -11,7 +11,10 @@
11
11
  export interface SenderDetails {
12
12
  /** Display name of sender. */
13
13
  fromName?: string;
14
- /** Email address of sender. */
14
+ /**
15
+ * Email address of sender.
16
+ * @format EMAIL
17
+ */
15
18
  fromEmail?: string;
16
19
  /**
17
20
  * Date and time the sender's email address was verified.
@@ -40,11 +43,17 @@ export interface VerifySenderEmailRequest {
40
43
  export interface VerifySenderEmailResponse {
41
44
  }
42
45
  export interface ResolveActualFromAddressRequest {
43
- /** User's provided address from which to send email marketing campaign. */
46
+ /**
47
+ * User's provided address from which to send email marketing campaign.
48
+ * @format EMAIL
49
+ */
44
50
  fromAddress: string;
45
51
  }
46
52
  export interface ResolveActualFromAddressResponse {
47
- /** Actual from-address that will be used for email distribution. */
53
+ /**
54
+ * Actual from-address that will be used for email distribution.
55
+ * @format EMAIL
56
+ */
48
57
  actualFromAddress?: string;
49
58
  }
50
59
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -118,9 +127,15 @@ export interface ActionEvent {
118
127
  body?: string;
119
128
  }
120
129
  export interface MessageEnvelope {
121
- /** App instance ID. */
130
+ /**
131
+ * App instance ID.
132
+ * @format GUID
133
+ */
122
134
  instanceId?: string | null;
123
- /** Event type. */
135
+ /**
136
+ * Event type.
137
+ * @maxLength 150
138
+ */
124
139
  eventType?: string;
125
140
  /** The identification type and identity data. */
126
141
  identity?: IdentificationData;
@@ -128,26 +143,50 @@ export interface MessageEnvelope {
128
143
  data?: string;
129
144
  }
130
145
  export interface IdentificationData extends IdentificationDataIdOneOf {
131
- /** ID of a site visitor that has not logged in to the site. */
146
+ /**
147
+ * ID of a site visitor that has not logged in to the site.
148
+ * @format GUID
149
+ */
132
150
  anonymousVisitorId?: string;
133
- /** ID of a site visitor that has logged in to the site. */
151
+ /**
152
+ * ID of a site visitor that has logged in to the site.
153
+ * @format GUID
154
+ */
134
155
  memberId?: string;
135
- /** ID of a Wix user (site owner, contributor, etc.). */
156
+ /**
157
+ * ID of a Wix user (site owner, contributor, etc.).
158
+ * @format GUID
159
+ */
136
160
  wixUserId?: string;
137
- /** ID of an app. */
161
+ /**
162
+ * ID of an app.
163
+ * @format GUID
164
+ */
138
165
  appId?: string;
139
166
  /** @readonly */
140
167
  identityType?: WebhookIdentityType;
141
168
  }
142
169
  /** @oneof */
143
170
  export interface IdentificationDataIdOneOf {
144
- /** ID of a site visitor that has not logged in to the site. */
171
+ /**
172
+ * ID of a site visitor that has not logged in to the site.
173
+ * @format GUID
174
+ */
145
175
  anonymousVisitorId?: string;
146
- /** ID of a site visitor that has logged in to the site. */
176
+ /**
177
+ * ID of a site visitor that has logged in to the site.
178
+ * @format GUID
179
+ */
147
180
  memberId?: string;
148
- /** ID of a Wix user (site owner, contributor, etc.). */
181
+ /**
182
+ * ID of a Wix user (site owner, contributor, etc.).
183
+ * @format GUID
184
+ */
149
185
  wixUserId?: string;
150
- /** ID of an app. */
186
+ /**
187
+ * ID of an app.
188
+ * @format GUID
189
+ */
151
190
  appId?: string;
152
191
  }
153
192
  export declare enum WebhookIdentityType {
@@ -171,9 +210,15 @@ export interface ResolveActualFromAddressResponseNonNullableFields {
171
210
  actualFromAddress: string;
172
211
  }
173
212
  export interface BaseEventMetadata {
174
- /** App instance ID. */
213
+ /**
214
+ * App instance ID.
215
+ * @format GUID
216
+ */
175
217
  instanceId?: string | null;
176
- /** Event type. */
218
+ /**
219
+ * Event type.
220
+ * @maxLength 150
221
+ */
177
222
  eventType?: string;
178
223
  /** The identification type and identity data. */
179
224
  identity?: IdentificationData;
@@ -222,6 +267,10 @@ export interface SenderDetailsUpdatedEnvelope {
222
267
  }
223
268
  /**
224
269
  * An event that triggers when sender details are updated without the need for explicit verification.
270
+ * @permissionScope Access Verticals by Automations
271
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
272
+ * @permissionScope Set Up Automations
273
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
225
274
  * @permissionScope Read Email Marketing
226
275
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
227
276
  * @permissionScope Manage Email Marketing
@@ -229,6 +278,8 @@ export interface SenderDetailsUpdatedEnvelope {
229
278
  * @permissionId Shoutout.Read
230
279
  * @webhook
231
280
  * @eventType wix.email_marketing.v1.sender_details_updated
281
+ * @serviceIdentifier wix.emailmarketing.api.v1.SenderDetailsService
282
+ * @slug updated
232
283
  */
233
284
  export declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpdatedEnvelope) => void | Promise<void>): void;
234
285
  /**
@@ -243,6 +294,10 @@ export declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpd
243
294
  * + 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.
244
295
  * @public
245
296
  * @permissionId Shoutout.Manage
297
+ * @permissionScope Access Verticals by Automations
298
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
299
+ * @permissionScope Set Up Automations
300
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
246
301
  * @permissionScope Manage Email Marketing
247
302
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
248
303
  * @applicableIdentity APP
@@ -263,6 +318,10 @@ export declare function getSenderDetails(): Promise<GetSenderDetailsResponse & G
263
318
  * @public
264
319
  * @requiredField senderDetails
265
320
  * @permissionId Shoutout.Manage
321
+ * @permissionScope Access Verticals by Automations
322
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
323
+ * @permissionScope Set Up Automations
324
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
266
325
  * @permissionScope Manage Email Marketing
267
326
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
268
327
  * @applicableIdentity APP
@@ -278,6 +337,10 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
278
337
  * @public
279
338
  * @requiredField verificationCode
280
339
  * @permissionId Shoutout.Manage
340
+ * @permissionScope Access Verticals by Automations
341
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
342
+ * @permissionScope Set Up Automations
343
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
281
344
  * @permissionScope Manage Email Marketing
282
345
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
283
346
  * @applicableIdentity APP
@@ -293,6 +356,10 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
293
356
  * @public
294
357
  * @requiredField fromAddress
295
358
  * @permissionId Shoutout.Manage
359
+ * @permissionScope Access Verticals by Automations
360
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
361
+ * @permissionScope Set Up Automations
362
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
296
363
  * @permissionScope Manage Email Marketing
297
364
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
298
365
  * @applicableIdentity APP