@wix/auto_sdk_email-marketing_sender-details 1.0.8 → 1.0.9

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 (134) hide show
  1. package/build/{es/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.mts} +76 -28
  2. package/build/{cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.ts} +76 -28
  3. package/build/index.d.mts +58 -0
  4. package/build/index.d.ts +58 -0
  5. package/build/index.js +441 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +412 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.mts} +76 -28
  10. package/build/internal/{es/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.ts} +76 -28
  11. package/build/internal/index.d.mts +58 -0
  12. package/build/internal/index.d.ts +58 -0
  13. package/build/internal/index.js +441 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +412 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +77 -0
  18. package/build/internal/meta.d.ts +77 -0
  19. package/build/internal/meta.js +341 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +311 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +77 -0
  24. package/build/meta.d.ts +77 -0
  25. package/build/meta.js +341 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +311 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
  40. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +0 -18
  41. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
  42. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
  43. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +0 -260
  44. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
  45. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
  46. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -104
  47. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
  48. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
  49. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +0 -45
  50. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
  51. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +0 -12
  52. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
  53. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
  54. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -218
  55. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
  67. package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js +0 -14
  68. package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
  69. package/build/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
  70. package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js +0 -253
  71. package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
  72. package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
  73. package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -74
  74. package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
  75. package/build/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
  76. package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js +0 -37
  77. package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
  78. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js +0 -9
  79. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
  80. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
  81. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -188
  82. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
  93. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +0 -18
  94. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
  95. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
  96. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +0 -260
  97. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
  98. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
  99. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -104
  100. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
  101. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
  102. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +0 -45
  103. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
  104. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +0 -12
  105. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
  106. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
  107. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -218
  108. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
  119. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js +0 -14
  120. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
  121. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
  122. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js +0 -253
  123. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
  124. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
  125. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -74
  126. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
  127. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
  128. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js +0 -37
  129. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
  130. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js +0 -9
  131. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
  132. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
  133. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -188
  134. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
@@ -1,355 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /**
3
- * A sender details object contains the information that is displayed as the email sender's name and email address.
4
- * If sending email campaigns with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not
5
- * be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users),
6
- * and the sender's email is placed in the 'reply-to' header.
7
- *
8
- * If sending email campaigns with an email from a Wix managed domain, that email will be displayed in the 'from' header.
9
- * If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the
10
- * email was sent via wixemails.com.
11
- */
12
- export interface SenderDetails {
13
- /** Display name of sender. */
14
- fromName?: string;
15
- /**
16
- * Email address of sender.
17
- * @format EMAIL
18
- */
19
- fromEmail?: string;
20
- /**
21
- * Date and time the sender's email address was verified.
22
- * @readonly
23
- */
24
- dateVerified?: Date | null;
25
- }
26
- export interface GetSenderDetailsRequest {
27
- }
28
- export interface GetSenderDetailsResponse {
29
- /** Current sender details. */
30
- senderDetails?: SenderDetails;
31
- }
32
- export interface UpdateSenderDetailsRequest {
33
- /** New sender details. */
34
- senderDetails: SenderDetails;
35
- }
36
- export interface UpdateSenderDetailsResponse {
37
- /** Whether email address needs verification. */
38
- verificationNeeded?: boolean;
39
- }
40
- export interface VerifySenderEmailRequest {
41
- /** Verification code. */
42
- verificationCode: string;
43
- }
44
- export interface VerifySenderEmailResponse {
45
- }
46
- export interface ResolveActualFromAddressRequest {
47
- /**
48
- * User's provided address from which to send email marketing campaign.
49
- * @format EMAIL
50
- */
51
- fromAddress: string;
52
- }
53
- export interface ResolveActualFromAddressResponse {
54
- /**
55
- * Actual from-address that will be used for email distribution.
56
- * @format EMAIL
57
- */
58
- actualFromAddress?: string;
59
- }
60
- export interface DomainEvent extends DomainEventBodyOneOf {
61
- createdEvent?: EntityCreatedEvent;
62
- updatedEvent?: EntityUpdatedEvent;
63
- deletedEvent?: EntityDeletedEvent;
64
- actionEvent?: ActionEvent;
65
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
66
- _id?: string;
67
- /**
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`.
70
- */
71
- entityFqdn?: string;
72
- /**
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`.
75
- */
76
- slug?: string;
77
- /** ID of the entity associated with the event. */
78
- entityId?: string;
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`. */
80
- eventTime?: Date | null;
81
- /**
82
- * Whether the event was triggered as a result of a privacy regulation application
83
- * (for example, GDPR).
84
- */
85
- triggeredByAnonymizeRequest?: boolean | null;
86
- /** If present, indicates the action that triggered the event. */
87
- originatedFrom?: string | null;
88
- /**
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.
91
- */
92
- entityEventSequence?: string | null;
93
- }
94
- /** @oneof */
95
- export interface DomainEventBodyOneOf {
96
- createdEvent?: EntityCreatedEvent;
97
- updatedEvent?: EntityUpdatedEvent;
98
- deletedEvent?: EntityDeletedEvent;
99
- actionEvent?: ActionEvent;
100
- }
101
- export interface EntityCreatedEvent {
102
- entity?: string;
103
- }
104
- export interface RestoreInfo {
105
- deletedDate?: Date | null;
106
- }
107
- export interface EntityUpdatedEvent {
108
- /**
109
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
110
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
111
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
112
- */
113
- currentEntity?: string;
114
- }
115
- export interface EntityDeletedEvent {
116
- /** Entity that was deleted. */
117
- deletedEntity?: string | null;
118
- }
119
- export interface ActionEvent {
120
- body?: string;
121
- }
122
- export interface MessageEnvelope {
123
- /**
124
- * App instance ID.
125
- * @format GUID
126
- */
127
- instanceId?: string | null;
128
- /**
129
- * Event type.
130
- * @maxLength 150
131
- */
132
- eventType?: string;
133
- /** The identification type and identity data. */
134
- identity?: IdentificationData;
135
- /** Stringify payload. */
136
- data?: string;
137
- }
138
- export interface IdentificationData extends IdentificationDataIdOneOf {
139
- /**
140
- * ID of a site visitor that has not logged in to the site.
141
- * @format GUID
142
- */
143
- anonymousVisitorId?: string;
144
- /**
145
- * ID of a site visitor that has logged in to the site.
146
- * @format GUID
147
- */
148
- memberId?: string;
149
- /**
150
- * ID of a Wix user (site owner, contributor, etc.).
151
- * @format GUID
152
- */
153
- wixUserId?: string;
154
- /**
155
- * ID of an app.
156
- * @format GUID
157
- */
158
- appId?: string;
159
- /** @readonly */
160
- identityType?: WebhookIdentityTypeWithLiterals;
161
- }
162
- /** @oneof */
163
- export interface IdentificationDataIdOneOf {
164
- /**
165
- * ID of a site visitor that has not logged in to the site.
166
- * @format GUID
167
- */
168
- anonymousVisitorId?: string;
169
- /**
170
- * ID of a site visitor that has logged in to the site.
171
- * @format GUID
172
- */
173
- memberId?: string;
174
- /**
175
- * ID of a Wix user (site owner, contributor, etc.).
176
- * @format GUID
177
- */
178
- wixUserId?: string;
179
- /**
180
- * ID of an app.
181
- * @format GUID
182
- */
183
- appId?: string;
184
- }
185
- export declare enum WebhookIdentityType {
186
- UNKNOWN = "UNKNOWN",
187
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
188
- MEMBER = "MEMBER",
189
- WIX_USER = "WIX_USER",
190
- APP = "APP"
191
- }
192
- /** @enumType */
193
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
194
- export interface BaseEventMetadata {
195
- /**
196
- * App instance ID.
197
- * @format GUID
198
- */
199
- instanceId?: string | null;
200
- /**
201
- * Event type.
202
- * @maxLength 150
203
- */
204
- eventType?: string;
205
- /** The identification type and identity data. */
206
- identity?: IdentificationData;
207
- }
208
- export interface EventMetadata extends BaseEventMetadata {
209
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
210
- _id?: string;
211
- /**
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`.
214
- */
215
- entityFqdn?: string;
216
- /**
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`.
219
- */
220
- slug?: string;
221
- /** ID of the entity associated with the event. */
222
- entityId?: string;
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`. */
224
- eventTime?: Date | null;
225
- /**
226
- * Whether the event was triggered as a result of a privacy regulation application
227
- * (for example, GDPR).
228
- */
229
- triggeredByAnonymizeRequest?: boolean | null;
230
- /** If present, indicates the action that triggered the event. */
231
- originatedFrom?: string | null;
232
- /**
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.
235
- */
236
- entityEventSequence?: string | null;
237
- }
238
- export interface SenderDetailsUpdatedEnvelope {
239
- entity: SenderDetails;
240
- metadata: EventMetadata;
241
- }
242
- /**
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
246
- * @permissionScope Access Verticals by Automations
247
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
248
- * @permissionScope Set Up Automations
249
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
250
- * @permissionScope Read Email Marketing
251
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
252
- * @permissionScope Manage Email Marketing
253
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
254
- * @permissionId Shoutout.Read
255
- * @webhook
256
- * @eventType wix.email_marketing.v1.sender_details_updated
257
- * @serviceIdentifier wix.emailmarketing.api.v1.SenderDetailsService
258
- * @slug updated
259
- */
260
- export declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpdatedEnvelope) => void | Promise<void>): void;
261
- type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
262
- /**
263
- * Retrieves sender details.
264
- *
265
- * The sender details include the information displayed as the email sender's name and email address.
266
- *
267
- * + If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.
268
- * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
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.
270
- * @public
271
- * @permissionId Shoutout.Manage
272
- * @permissionScope Manage Stores
273
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
274
- * @permissionScope Access Verticals by Automations
275
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
276
- * @permissionScope Set Up Automations
277
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
278
- * @permissionScope Manage Email Marketing
279
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
280
- * @applicableIdentity APP
281
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get
282
- * @deprecated
283
- * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails
284
- * @targetRemovalDate 2025-09-30
285
- */
286
- export declare function getSenderDetails(): Promise<NonNullablePaths<GetSenderDetailsResponse, {
287
- [P in SenderDetailsNonNullablePaths]: `senderDetails.${P}`;
288
- }[SenderDetailsNonNullablePaths]>>;
289
- /**
290
- * Updates sender details (only provided fields will be updated).
291
- *
292
- * If `from_email` is changed - a verification code will be sent to new email address.
293
- * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.
294
- * @param senderDetails - New sender details.
295
- * @public
296
- * @requiredField senderDetails
297
- * @permissionId Shoutout.Manage
298
- * @permissionScope Manage Stores
299
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
300
- * @permissionScope Access Verticals by Automations
301
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
302
- * @permissionScope Set Up Automations
303
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
304
- * @permissionScope Manage Email Marketing
305
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
306
- * @applicableIdentity APP
307
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update
308
- * @deprecated
309
- * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail
310
- * @targetRemovalDate 2025-09-30
311
- */
312
- export declare function updateSenderDetails(senderDetails: SenderDetails): Promise<NonNullablePaths<UpdateSenderDetailsResponse, `verificationNeeded`>>;
313
- /**
314
- * Verifies the sender's email using a verification code sent to the user's email address upon update.
315
- * @param verificationCode - Verification code.
316
- * @public
317
- * @requiredField verificationCode
318
- * @permissionId Shoutout.Manage
319
- * @permissionScope Manage Stores
320
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
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
325
- * @permissionScope Manage Email Marketing
326
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
327
- * @applicableIdentity APP
328
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail
329
- * @deprecated
330
- * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail
331
- * @targetRemovalDate 2025-09-30
332
- */
333
- export declare function verifyEmail(verificationCode: string): Promise<void>;
334
- /**
335
- * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
336
- * @param fromAddress - User's provided address from which to send email marketing campaign.
337
- * @public
338
- * @requiredField fromAddress
339
- * @permissionId Shoutout.Manage
340
- * @permissionScope Manage Stores
341
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
342
- * @permissionScope Access Verticals by Automations
343
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
344
- * @permissionScope Set Up Automations
345
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
346
- * @permissionScope Manage Email Marketing
347
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
348
- * @applicableIdentity APP
349
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress
350
- * @deprecated
351
- * @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
352
- * @targetRemovalDate 2025-09-30
353
- */
354
- export declare function resolveActualFromAddress(fromAddress: string): Promise<NonNullablePaths<ResolveActualFromAddressResponse, `actualFromAddress`>>;
355
- export {};
@@ -1,188 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
3
- import * as ambassadorWixEmailMarketingV1SenderDetails from './email-marketing-v1-sender-details-sender-details.http.js';
4
- export var WebhookIdentityType;
5
- (function (WebhookIdentityType) {
6
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
7
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
8
- WebhookIdentityType["MEMBER"] = "MEMBER";
9
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
10
- WebhookIdentityType["APP"] = "APP";
11
- })(WebhookIdentityType || (WebhookIdentityType = {}));
12
- /**
13
- * Retrieves sender details.
14
- *
15
- * The sender details include the information displayed as the email sender's name and email address.
16
- *
17
- * + If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.
18
- * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
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
- * @public
21
- * @permissionId Shoutout.Manage
22
- * @permissionScope Manage Stores
23
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
24
- * @permissionScope Access Verticals by Automations
25
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
26
- * @permissionScope Set Up Automations
27
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
28
- * @permissionScope Manage Email Marketing
29
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
30
- * @applicableIdentity APP
31
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get
32
- * @deprecated
33
- * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails
34
- * @targetRemovalDate 2025-09-30
35
- */
36
- export async function getSenderDetails() {
37
- // @ts-ignore
38
- const { httpClient, sideEffects } = arguments[0];
39
- const payload = renameKeysFromSDKRequestToRESTRequest({});
40
- const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.get(payload);
41
- sideEffects?.onSiteCall?.();
42
- try {
43
- const result = await httpClient.request(reqOpts);
44
- sideEffects?.onSuccess?.(result);
45
- return renameKeysFromRESTResponseToSDKResponse(result.data);
46
- }
47
- catch (err) {
48
- const transformedError = sdkTransformError(err, {
49
- spreadPathsToArguments: {},
50
- explicitPathsToArguments: {},
51
- singleArgumentUnchanged: false,
52
- }, []);
53
- sideEffects?.onError?.(err);
54
- throw transformedError;
55
- }
56
- }
57
- /**
58
- * Updates sender details (only provided fields will be updated).
59
- *
60
- * If `from_email` is changed - a verification code will be sent to new email address.
61
- * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.
62
- * @param senderDetails - New sender details.
63
- * @public
64
- * @requiredField senderDetails
65
- * @permissionId Shoutout.Manage
66
- * @permissionScope Manage Stores
67
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
68
- * @permissionScope Access Verticals by Automations
69
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
70
- * @permissionScope Set Up Automations
71
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
72
- * @permissionScope Manage Email Marketing
73
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
74
- * @applicableIdentity APP
75
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update
76
- * @deprecated
77
- * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail
78
- * @targetRemovalDate 2025-09-30
79
- */
80
- export async function updateSenderDetails(senderDetails) {
81
- // @ts-ignore
82
- const { httpClient, sideEffects } = arguments[1];
83
- const payload = renameKeysFromSDKRequestToRESTRequest({
84
- senderDetails: senderDetails,
85
- });
86
- const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.update(payload);
87
- sideEffects?.onSiteCall?.();
88
- try {
89
- const result = await httpClient.request(reqOpts);
90
- sideEffects?.onSuccess?.(result);
91
- return renameKeysFromRESTResponseToSDKResponse(result.data);
92
- }
93
- catch (err) {
94
- const transformedError = sdkTransformError(err, {
95
- spreadPathsToArguments: {},
96
- explicitPathsToArguments: { senderDetails: '$[0]' },
97
- singleArgumentUnchanged: false,
98
- }, ['senderDetails']);
99
- sideEffects?.onError?.(err);
100
- throw transformedError;
101
- }
102
- }
103
- /**
104
- * Verifies the sender's email using a verification code sent to the user's email address upon update.
105
- * @param verificationCode - Verification code.
106
- * @public
107
- * @requiredField verificationCode
108
- * @permissionId Shoutout.Manage
109
- * @permissionScope Manage Stores
110
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
111
- * @permissionScope Access Verticals by Automations
112
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
113
- * @permissionScope Set Up Automations
114
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
115
- * @permissionScope Manage Email Marketing
116
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
117
- * @applicableIdentity APP
118
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail
119
- * @deprecated
120
- * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail
121
- * @targetRemovalDate 2025-09-30
122
- */
123
- export async function verifyEmail(verificationCode) {
124
- // @ts-ignore
125
- const { httpClient, sideEffects } = arguments[1];
126
- const payload = renameKeysFromSDKRequestToRESTRequest({
127
- verificationCode: verificationCode,
128
- });
129
- const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.verifyEmail(payload);
130
- sideEffects?.onSiteCall?.();
131
- try {
132
- const result = await httpClient.request(reqOpts);
133
- sideEffects?.onSuccess?.(result);
134
- }
135
- catch (err) {
136
- const transformedError = sdkTransformError(err, {
137
- spreadPathsToArguments: {},
138
- explicitPathsToArguments: { verificationCode: '$[0]' },
139
- singleArgumentUnchanged: false,
140
- }, ['verificationCode']);
141
- sideEffects?.onError?.(err);
142
- throw transformedError;
143
- }
144
- }
145
- /**
146
- * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
147
- * @param fromAddress - User's provided address from which to send email marketing campaign.
148
- * @public
149
- * @requiredField fromAddress
150
- * @permissionId Shoutout.Manage
151
- * @permissionScope Manage Stores
152
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
153
- * @permissionScope Access Verticals by Automations
154
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
155
- * @permissionScope Set Up Automations
156
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
157
- * @permissionScope Manage Email Marketing
158
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
159
- * @applicableIdentity APP
160
- * @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress
161
- * @deprecated
162
- * @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
163
- * @targetRemovalDate 2025-09-30
164
- */
165
- export async function resolveActualFromAddress(fromAddress) {
166
- // @ts-ignore
167
- const { httpClient, sideEffects } = arguments[1];
168
- const payload = renameKeysFromSDKRequestToRESTRequest({
169
- fromAddress: fromAddress,
170
- });
171
- const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.resolveActualFromAddress(payload);
172
- sideEffects?.onSiteCall?.();
173
- try {
174
- const result = await httpClient.request(reqOpts);
175
- sideEffects?.onSuccess?.(result);
176
- return renameKeysFromRESTResponseToSDKResponse(result.data);
177
- }
178
- catch (err) {
179
- const transformedError = sdkTransformError(err, {
180
- spreadPathsToArguments: {},
181
- explicitPathsToArguments: { fromAddress: '$[0]' },
182
- singleArgumentUnchanged: false,
183
- }, ['fromAddress']);
184
- sideEffects?.onError?.(err);
185
- throw transformedError;
186
- }
187
- }
188
- //# sourceMappingURL=email-marketing-v1-sender-details-sender-details.universal.js.map
@@ -1 +0,0 @@
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"}