@wix/auto_sdk_email-marketing_sender-details 1.0.0

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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
  11. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +18 -0
  12. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
  13. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
  14. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +263 -0
  15. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
  16. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
  17. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +104 -0
  18. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
  19. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
  20. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +45 -0
  21. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
  22. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
  23. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +12 -0
  24. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
  25. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
  26. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +198 -0
  27. package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
  39. package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js +14 -0
  40. package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
  41. package/build/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
  42. package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js +256 -0
  43. package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
  44. package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
  45. package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js +74 -0
  46. package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
  47. package/build/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
  48. package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js +37 -0
  49. package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
  50. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
  51. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js +9 -0
  52. package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
  53. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
  54. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js +168 -0
  55. package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
  66. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +18 -0
  67. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
  68. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
  69. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +263 -0
  70. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
  71. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
  72. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +104 -0
  73. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
  74. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
  75. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +45 -0
  76. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
  77. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
  78. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +12 -0
  79. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
  80. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
  81. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +198 -0
  82. package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
  93. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js +14 -0
  94. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
  95. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
  96. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js +256 -0
  97. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
  98. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
  99. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js +74 -0
  100. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
  101. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
  102. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js +37 -0
  103. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
  104. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
  105. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js +9 -0
  106. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
  107. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
  108. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js +168 -0
  109. package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,305 @@
1
+ /**
2
+ * A sender details object contains the information that is displayed as the email sender's name and email address.
3
+ * If sending email campaigns with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not
4
+ * be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users),
5
+ * and the sender's email is placed in the 'reply-to' header.
6
+ *
7
+ * If sending email campaigns with an email from a Wix managed domain, that email will be displayed in the 'from' header.
8
+ * If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the
9
+ * email was sent via wixemails.com.
10
+ */
11
+ export interface SenderDetails {
12
+ /** Display name of sender. */
13
+ fromName?: string;
14
+ /** Email address of sender. */
15
+ fromEmail?: string;
16
+ /**
17
+ * Date and time the sender's email address was verified.
18
+ * @readonly
19
+ */
20
+ dateVerified?: Date | null;
21
+ }
22
+ export interface GetSenderDetailsRequest {
23
+ }
24
+ export interface GetSenderDetailsResponse {
25
+ /** Current sender details. */
26
+ senderDetails?: SenderDetails;
27
+ }
28
+ export interface UpdateSenderDetailsRequest {
29
+ /** New sender details. */
30
+ senderDetails: SenderDetails;
31
+ }
32
+ export interface UpdateSenderDetailsResponse {
33
+ /** Whether email address needs verification. */
34
+ verificationNeeded?: boolean;
35
+ }
36
+ export interface VerifySenderEmailRequest {
37
+ /** Verification code. */
38
+ verificationCode: string;
39
+ }
40
+ export interface VerifySenderEmailResponse {
41
+ }
42
+ export interface ResolveActualFromAddressRequest {
43
+ /** User's provided address from which to send email marketing campaign. */
44
+ fromAddress: string;
45
+ }
46
+ export interface ResolveActualFromAddressResponse {
47
+ /** Actual from-address that will be used for email distribution. */
48
+ actualFromAddress?: string;
49
+ }
50
+ export interface DomainEvent extends DomainEventBodyOneOf {
51
+ createdEvent?: EntityCreatedEvent;
52
+ updatedEvent?: EntityUpdatedEvent;
53
+ deletedEvent?: EntityDeletedEvent;
54
+ actionEvent?: ActionEvent;
55
+ /**
56
+ * Unique event ID.
57
+ * Allows clients to ignore duplicate webhooks.
58
+ */
59
+ _id?: string;
60
+ /**
61
+ * Assumes actions are also always typed to an entity_type
62
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
63
+ */
64
+ entityFqdn?: string;
65
+ /**
66
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
67
+ * This is although the created/updated/deleted notion is duplication of the oneof types
68
+ * Example: created/updated/deleted/started/completed/email_opened
69
+ */
70
+ slug?: string;
71
+ /** ID of the entity associated with the event. */
72
+ entityId?: string;
73
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
74
+ eventTime?: Date | null;
75
+ /**
76
+ * Whether the event was triggered as a result of a privacy regulation application
77
+ * (for example, GDPR).
78
+ */
79
+ triggeredByAnonymizeRequest?: boolean | null;
80
+ /** If present, indicates the action that triggered the event. */
81
+ originatedFrom?: string | null;
82
+ /**
83
+ * A sequence number defining the order of updates to the underlying entity.
84
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
85
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
86
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
87
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
88
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
89
+ */
90
+ entityEventSequence?: string | null;
91
+ }
92
+ /** @oneof */
93
+ export interface DomainEventBodyOneOf {
94
+ createdEvent?: EntityCreatedEvent;
95
+ updatedEvent?: EntityUpdatedEvent;
96
+ deletedEvent?: EntityDeletedEvent;
97
+ actionEvent?: ActionEvent;
98
+ }
99
+ export interface EntityCreatedEvent {
100
+ entity?: string;
101
+ }
102
+ export interface RestoreInfo {
103
+ deletedDate?: Date | null;
104
+ }
105
+ export interface EntityUpdatedEvent {
106
+ /**
107
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
108
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
109
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
110
+ */
111
+ currentEntity?: string;
112
+ }
113
+ export interface EntityDeletedEvent {
114
+ /** Entity that was deleted */
115
+ deletedEntity?: string | null;
116
+ }
117
+ export interface ActionEvent {
118
+ body?: string;
119
+ }
120
+ export interface MessageEnvelope {
121
+ /** App instance ID. */
122
+ instanceId?: string | null;
123
+ /** Event type. */
124
+ eventType?: string;
125
+ /** The identification type and identity data. */
126
+ identity?: IdentificationData;
127
+ /** Stringify payload. */
128
+ data?: string;
129
+ }
130
+ export interface IdentificationData extends IdentificationDataIdOneOf {
131
+ /** ID of a site visitor that has not logged in to the site. */
132
+ anonymousVisitorId?: string;
133
+ /** ID of a site visitor that has logged in to the site. */
134
+ memberId?: string;
135
+ /** ID of a Wix user (site owner, contributor, etc.). */
136
+ wixUserId?: string;
137
+ /** ID of an app. */
138
+ appId?: string;
139
+ /** @readonly */
140
+ identityType?: WebhookIdentityType;
141
+ }
142
+ /** @oneof */
143
+ export interface IdentificationDataIdOneOf {
144
+ /** ID of a site visitor that has not logged in to the site. */
145
+ anonymousVisitorId?: string;
146
+ /** ID of a site visitor that has logged in to the site. */
147
+ memberId?: string;
148
+ /** ID of a Wix user (site owner, contributor, etc.). */
149
+ wixUserId?: string;
150
+ /** ID of an app. */
151
+ appId?: string;
152
+ }
153
+ export declare enum WebhookIdentityType {
154
+ UNKNOWN = "UNKNOWN",
155
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
156
+ MEMBER = "MEMBER",
157
+ WIX_USER = "WIX_USER",
158
+ APP = "APP"
159
+ }
160
+ interface SenderDetailsNonNullableFields {
161
+ fromName: string;
162
+ fromEmail: string;
163
+ }
164
+ export interface GetSenderDetailsResponseNonNullableFields {
165
+ senderDetails?: SenderDetailsNonNullableFields;
166
+ }
167
+ export interface UpdateSenderDetailsResponseNonNullableFields {
168
+ verificationNeeded: boolean;
169
+ }
170
+ export interface ResolveActualFromAddressResponseNonNullableFields {
171
+ actualFromAddress: string;
172
+ }
173
+ export interface BaseEventMetadata {
174
+ /** App instance ID. */
175
+ instanceId?: string | null;
176
+ /** Event type. */
177
+ eventType?: string;
178
+ /** The identification type and identity data. */
179
+ identity?: IdentificationData;
180
+ }
181
+ export interface EventMetadata extends BaseEventMetadata {
182
+ /**
183
+ * Unique event ID.
184
+ * Allows clients to ignore duplicate webhooks.
185
+ */
186
+ _id?: string;
187
+ /**
188
+ * Assumes actions are also always typed to an entity_type
189
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
190
+ */
191
+ entityFqdn?: string;
192
+ /**
193
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
194
+ * This is although the created/updated/deleted notion is duplication of the oneof types
195
+ * Example: created/updated/deleted/started/completed/email_opened
196
+ */
197
+ slug?: string;
198
+ /** ID of the entity associated with the event. */
199
+ entityId?: string;
200
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
201
+ eventTime?: Date | null;
202
+ /**
203
+ * Whether the event was triggered as a result of a privacy regulation application
204
+ * (for example, GDPR).
205
+ */
206
+ triggeredByAnonymizeRequest?: boolean | null;
207
+ /** If present, indicates the action that triggered the event. */
208
+ originatedFrom?: string | null;
209
+ /**
210
+ * A sequence number defining the order of updates to the underlying entity.
211
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
212
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
213
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
214
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
215
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
216
+ */
217
+ entityEventSequence?: string | null;
218
+ }
219
+ export interface SenderDetailsUpdatedEnvelope {
220
+ entity: SenderDetails;
221
+ metadata: EventMetadata;
222
+ }
223
+ /**
224
+ * An event that triggers when sender details are updated without the need for explicit verification.
225
+ * @permissionScope Read Email Marketing
226
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
227
+ * @permissionScope Manage Email Marketing
228
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
229
+ * @permissionId Shoutout.Read
230
+ * @webhook
231
+ * @eventType wix.email_marketing.v1.sender_details_updated
232
+ */
233
+ export declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpdatedEnvelope) => void | Promise<void>): void;
234
+ /**
235
+ * Retrieves sender details.
236
+ *
237
+ * The sender details include the information displayed as the email sender's name and email address.
238
+ *
239
+ * + 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.
240
+ *
241
+ * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
242
+ *
243
+ * + 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
+ * @public
245
+ * @permissionId Shoutout.Manage
246
+ * @permissionScope Manage Email Marketing
247
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
248
+ * @applicableIdentity APP
249
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get
250
+ * @deprecated
251
+ * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails
252
+ * @targetRemovalDate 2025-09-30
253
+ */
254
+ export declare function getSenderDetails(): Promise<GetSenderDetailsResponse & GetSenderDetailsResponseNonNullableFields>;
255
+ /**
256
+ * Updates sender details.
257
+ *
258
+ * If the `fromEmail` is changed, a verification code will be sent to the new email address.
259
+ *
260
+ * If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
261
+ *
262
+ * @param senderDetails - New sender details.
263
+ * @public
264
+ * @requiredField senderDetails
265
+ * @permissionId Shoutout.Manage
266
+ * @permissionScope Manage Email Marketing
267
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
268
+ * @applicableIdentity APP
269
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update
270
+ * @deprecated
271
+ * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail
272
+ * @targetRemovalDate 2025-09-30
273
+ */
274
+ export declare function updateSenderDetails(senderDetails: SenderDetails): Promise<UpdateSenderDetailsResponse & UpdateSenderDetailsResponseNonNullableFields>;
275
+ /**
276
+ * Verifies the sender's email using a verification code sent to the user's email address upon update.
277
+ * @param verificationCode - Verification code.
278
+ * @public
279
+ * @requiredField verificationCode
280
+ * @permissionId Shoutout.Manage
281
+ * @permissionScope Manage Email Marketing
282
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
283
+ * @applicableIdentity APP
284
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail
285
+ * @deprecated
286
+ * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail
287
+ * @targetRemovalDate 2025-09-30
288
+ */
289
+ export declare function verifyEmail(verificationCode: string): Promise<void>;
290
+ /**
291
+ * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
292
+ * @param fromAddress - User's provided address from which to send email marketing campaign.
293
+ * @public
294
+ * @requiredField fromAddress
295
+ * @permissionId Shoutout.Manage
296
+ * @permissionScope Manage Email Marketing
297
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
298
+ * @applicableIdentity APP
299
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress
300
+ * @deprecated
301
+ * @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
302
+ * @targetRemovalDate 2025-09-30
303
+ */
304
+ export declare function resolveActualFromAddress(fromAddress: string): Promise<ResolveActualFromAddressResponse & ResolveActualFromAddressResponseNonNullableFields>;
305
+ export {};
@@ -0,0 +1,168 @@
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
+ *
19
+ * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
20
+ *
21
+ * + 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.
22
+ * @public
23
+ * @permissionId Shoutout.Manage
24
+ * @permissionScope Manage Email Marketing
25
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
26
+ * @applicableIdentity APP
27
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get
28
+ * @deprecated
29
+ * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails
30
+ * @targetRemovalDate 2025-09-30
31
+ */
32
+ export async function getSenderDetails() {
33
+ // @ts-ignore
34
+ const { httpClient, sideEffects } = arguments[0];
35
+ const payload = renameKeysFromSDKRequestToRESTRequest({});
36
+ const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.get(payload);
37
+ sideEffects?.onSiteCall?.();
38
+ try {
39
+ const result = await httpClient.request(reqOpts);
40
+ sideEffects?.onSuccess?.(result);
41
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
42
+ }
43
+ catch (err) {
44
+ const transformedError = sdkTransformError(err, {
45
+ spreadPathsToArguments: {},
46
+ explicitPathsToArguments: {},
47
+ singleArgumentUnchanged: false,
48
+ }, []);
49
+ sideEffects?.onError?.(err);
50
+ throw transformedError;
51
+ }
52
+ }
53
+ /**
54
+ * Updates sender details.
55
+ *
56
+ * If the `fromEmail` is changed, a verification code will be sent to the new email address.
57
+ *
58
+ * If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
59
+ *
60
+ * @param senderDetails - New sender details.
61
+ * @public
62
+ * @requiredField senderDetails
63
+ * @permissionId Shoutout.Manage
64
+ * @permissionScope Manage Email Marketing
65
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
66
+ * @applicableIdentity APP
67
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update
68
+ * @deprecated
69
+ * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail
70
+ * @targetRemovalDate 2025-09-30
71
+ */
72
+ export async function updateSenderDetails(senderDetails) {
73
+ // @ts-ignore
74
+ const { httpClient, sideEffects } = arguments[1];
75
+ const payload = renameKeysFromSDKRequestToRESTRequest({
76
+ senderDetails: senderDetails,
77
+ });
78
+ const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.update(payload);
79
+ sideEffects?.onSiteCall?.();
80
+ try {
81
+ const result = await httpClient.request(reqOpts);
82
+ sideEffects?.onSuccess?.(result);
83
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
84
+ }
85
+ catch (err) {
86
+ const transformedError = sdkTransformError(err, {
87
+ spreadPathsToArguments: {},
88
+ explicitPathsToArguments: { senderDetails: '$[0]' },
89
+ singleArgumentUnchanged: false,
90
+ }, ['senderDetails']);
91
+ sideEffects?.onError?.(err);
92
+ throw transformedError;
93
+ }
94
+ }
95
+ /**
96
+ * Verifies the sender's email using a verification code sent to the user's email address upon update.
97
+ * @param verificationCode - Verification code.
98
+ * @public
99
+ * @requiredField verificationCode
100
+ * @permissionId Shoutout.Manage
101
+ * @permissionScope Manage Email Marketing
102
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
103
+ * @applicableIdentity APP
104
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail
105
+ * @deprecated
106
+ * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail
107
+ * @targetRemovalDate 2025-09-30
108
+ */
109
+ export async function verifyEmail(verificationCode) {
110
+ // @ts-ignore
111
+ const { httpClient, sideEffects } = arguments[1];
112
+ const payload = renameKeysFromSDKRequestToRESTRequest({
113
+ verificationCode: verificationCode,
114
+ });
115
+ const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.verifyEmail(payload);
116
+ sideEffects?.onSiteCall?.();
117
+ try {
118
+ const result = await httpClient.request(reqOpts);
119
+ sideEffects?.onSuccess?.(result);
120
+ }
121
+ catch (err) {
122
+ const transformedError = sdkTransformError(err, {
123
+ spreadPathsToArguments: {},
124
+ explicitPathsToArguments: { verificationCode: '$[0]' },
125
+ singleArgumentUnchanged: false,
126
+ }, ['verificationCode']);
127
+ sideEffects?.onError?.(err);
128
+ throw transformedError;
129
+ }
130
+ }
131
+ /**
132
+ * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
133
+ * @param fromAddress - User's provided address from which to send email marketing campaign.
134
+ * @public
135
+ * @requiredField fromAddress
136
+ * @permissionId Shoutout.Manage
137
+ * @permissionScope Manage Email Marketing
138
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
139
+ * @applicableIdentity APP
140
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress
141
+ * @deprecated
142
+ * @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
143
+ * @targetRemovalDate 2025-09-30
144
+ */
145
+ export async function resolveActualFromAddress(fromAddress) {
146
+ // @ts-ignore
147
+ const { httpClient, sideEffects } = arguments[1];
148
+ const payload = renameKeysFromSDKRequestToRESTRequest({
149
+ fromAddress: fromAddress,
150
+ });
151
+ const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.resolveActualFromAddress(payload);
152
+ sideEffects?.onSiteCall?.();
153
+ try {
154
+ const result = await httpClient.request(reqOpts);
155
+ sideEffects?.onSuccess?.(result);
156
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
157
+ }
158
+ catch (err) {
159
+ const transformedError = sdkTransformError(err, {
160
+ spreadPathsToArguments: {},
161
+ explicitPathsToArguments: { fromAddress: '$[0]' },
162
+ singleArgumentUnchanged: false,
163
+ }, ['fromAddress']);
164
+ sideEffects?.onError?.(err);
165
+ throw transformedError;
166
+ }
167
+ }
168
+ //# sourceMappingURL=email-marketing-v1-sender-details-sender-details.universal.js.map
@@ -0,0 +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;AA2KzH,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;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IAGpC,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;;;;;;;;;;;;;;;;;;GAkBG;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;;;;;;;;;;;;;GAaG;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;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAKnB,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"}
@@ -0,0 +1,3 @@
1
+ {
2
+ "main": "../build/cjs/meta.js"
3
+ }
package/package.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "name": "@wix/auto_sdk_email-marketing_sender-details",
3
+ "version": "1.0.0",
4
+ "publishConfig": {
5
+ "registry": "https://registry.npmjs.org/",
6
+ "access": "public"
7
+ },
8
+ "keywords": [],
9
+ "sideEffects": false,
10
+ "main": "./build/cjs/index.js",
11
+ "types": "./build/es/index.d.ts",
12
+ "exports": {
13
+ ".": {
14
+ "import": "./build/es/index.js",
15
+ "require": "./build/cjs/index.js",
16
+ "types": "./build/es/index.d.ts"
17
+ },
18
+ "./package.json": "./package.json",
19
+ "./meta": {
20
+ "import": "./build/es/meta.js",
21
+ "require": "./build/cjs/meta.js",
22
+ "types": "./build/es/meta.d.ts"
23
+ }
24
+ },
25
+ "files": [
26
+ "build",
27
+ "meta",
28
+ "service-plugins"
29
+ ],
30
+ "dependencies": {
31
+ "@wix/sdk-runtime": "^0.3.35",
32
+ "@wix/sdk-types": "^1.12.4"
33
+ },
34
+ "devDependencies": {
35
+ "typescript": "^5.3.2"
36
+ },
37
+ "scripts": {
38
+ "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
39
+ "test": ":"
40
+ },
41
+ "wix": {
42
+ "artifact": {
43
+ "artifactId": "auto-sdk-email-marketing-sender-details",
44
+ "groupId": "com.wixpress.public-sdk-dependencies"
45
+ },
46
+ "sdkDependency": {
47
+ "fqdnNamespace": "senderDetails",
48
+ "fqdn": "wix.email_marketing.v1.sender_details"
49
+ }
50
+ },
51
+ "falconPackageHash": "78789edc42de11d6de643d455c101f42eddf4698a066500e8393333d"
52
+ }