@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.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +18 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +263 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +104 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +45 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +12 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +198 -0
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js +14 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js +256 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js +74 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js +37 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js +9 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js +168 -0
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +18 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +263 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +104 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +45 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +12 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +198 -0
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +14 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js +14 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +1 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +33 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js +256 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +1 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +16 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js +74 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +1 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +51 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js +37 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +1 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.d.ts +175 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js +9 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +1 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +305 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js +168 -0
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
|
|
2
|
+
import { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
|
|
3
|
+
import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
|
|
4
|
+
import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
|
|
5
|
+
import { resolveUrl } from '@wix/sdk-runtime/rest-modules';
|
|
6
|
+
function resolveWixEmailmarketingApiV1SenderDetailsServiceUrl(opts) {
|
|
7
|
+
const domainToMappings = {
|
|
8
|
+
'editor._base_domain_': [
|
|
9
|
+
{
|
|
10
|
+
srcPath: '/shoutout',
|
|
11
|
+
destPath: '',
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
srcPath: '/_api/shoutout-editor',
|
|
15
|
+
destPath: '/api',
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
srcPath: '/_api/shoutout/v1',
|
|
19
|
+
destPath: '/v1',
|
|
20
|
+
},
|
|
21
|
+
],
|
|
22
|
+
'blocks._base_domain_': [
|
|
23
|
+
{
|
|
24
|
+
srcPath: '/shoutout',
|
|
25
|
+
destPath: '',
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
srcPath: '/_api/shoutout-editor',
|
|
29
|
+
destPath: '/api',
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
srcPath: '/_api/shoutout/v1',
|
|
33
|
+
destPath: '/v1',
|
|
34
|
+
},
|
|
35
|
+
],
|
|
36
|
+
'create.editorx': [
|
|
37
|
+
{
|
|
38
|
+
srcPath: '/shoutout',
|
|
39
|
+
destPath: '',
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
srcPath: '/_api/shoutout-editor',
|
|
43
|
+
destPath: '/api',
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
srcPath: '/_api/shoutout/v1',
|
|
47
|
+
destPath: '/v1',
|
|
48
|
+
},
|
|
49
|
+
],
|
|
50
|
+
'shoutout._base_domain_': [
|
|
51
|
+
{
|
|
52
|
+
srcPath: '/_api/shoutout-editor',
|
|
53
|
+
destPath: '/api',
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
srcPath: '/_api/shoutout/v1',
|
|
57
|
+
destPath: '/v1',
|
|
58
|
+
},
|
|
59
|
+
],
|
|
60
|
+
'www._base_domain_': [
|
|
61
|
+
{
|
|
62
|
+
srcPath: '/_api/shoutout-editor',
|
|
63
|
+
destPath: '/api',
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
srcPath: '/_api/shoutout/v1',
|
|
67
|
+
destPath: '/v1',
|
|
68
|
+
},
|
|
69
|
+
],
|
|
70
|
+
'shoutouteditor._base_domain_': [
|
|
71
|
+
{
|
|
72
|
+
srcPath: '/_api/shoutout-editor',
|
|
73
|
+
destPath: '/api',
|
|
74
|
+
},
|
|
75
|
+
],
|
|
76
|
+
'api._api_base_domain_': [
|
|
77
|
+
{
|
|
78
|
+
srcPath: '/shoutout-editor',
|
|
79
|
+
destPath: '',
|
|
80
|
+
},
|
|
81
|
+
],
|
|
82
|
+
_: [
|
|
83
|
+
{
|
|
84
|
+
srcPath: '/_api/shoutout/v1',
|
|
85
|
+
destPath: '/v1',
|
|
86
|
+
},
|
|
87
|
+
],
|
|
88
|
+
'api._base_domain_': [
|
|
89
|
+
{
|
|
90
|
+
srcPath: '/_api/shoutout/v1',
|
|
91
|
+
destPath: '/v1',
|
|
92
|
+
},
|
|
93
|
+
],
|
|
94
|
+
'manage._base_domain_': [
|
|
95
|
+
{
|
|
96
|
+
srcPath: '/_api/shoutout-editor',
|
|
97
|
+
destPath: '/api',
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
srcPath: '/_api/shoutout/v1',
|
|
101
|
+
destPath: '/v1',
|
|
102
|
+
},
|
|
103
|
+
],
|
|
104
|
+
'www.wixapis.com': [
|
|
105
|
+
{
|
|
106
|
+
srcPath: '/email-marketing/v1',
|
|
107
|
+
destPath: '/v1',
|
|
108
|
+
},
|
|
109
|
+
],
|
|
110
|
+
'bo._base_domain_': [
|
|
111
|
+
{
|
|
112
|
+
srcPath: '/shoutout-editor/v1',
|
|
113
|
+
destPath: '/v1',
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
srcPath: '/_api/shoutout-editor',
|
|
117
|
+
destPath: '/api',
|
|
118
|
+
},
|
|
119
|
+
],
|
|
120
|
+
'wixbo.ai': [
|
|
121
|
+
{
|
|
122
|
+
srcPath: '/shoutout-editor/v1',
|
|
123
|
+
destPath: '/v1',
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
srcPath: '/_api/shoutout-editor',
|
|
127
|
+
destPath: '/api',
|
|
128
|
+
},
|
|
129
|
+
],
|
|
130
|
+
'wix-bo.com': [
|
|
131
|
+
{
|
|
132
|
+
srcPath: '/shoutout-editor/v1',
|
|
133
|
+
destPath: '/v1',
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
srcPath: '/_api/shoutout-editor',
|
|
137
|
+
destPath: '/api',
|
|
138
|
+
},
|
|
139
|
+
],
|
|
140
|
+
};
|
|
141
|
+
return resolveUrl(Object.assign(opts, { domainToMappings }));
|
|
142
|
+
}
|
|
143
|
+
const PACKAGE_NAME = '@wix/auto_sdk_email-marketing_sender-details';
|
|
144
|
+
/**
|
|
145
|
+
* Retrieves sender details.
|
|
146
|
+
*
|
|
147
|
+
* The sender details include the information displayed as the email sender's name and email address.
|
|
148
|
+
*
|
|
149
|
+
* + 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.
|
|
150
|
+
*
|
|
151
|
+
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
152
|
+
*
|
|
153
|
+
* + 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.
|
|
154
|
+
* @deprecated It has been replaced with wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails(), and will be removed on 2025-09-30.
|
|
155
|
+
*/
|
|
156
|
+
export function get(payload) {
|
|
157
|
+
function __get({ host }) {
|
|
158
|
+
const metadata = {
|
|
159
|
+
entityFqdn: 'wix.email_marketing.v1.sender_details',
|
|
160
|
+
method: 'GET',
|
|
161
|
+
methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.Get',
|
|
162
|
+
packageName: PACKAGE_NAME,
|
|
163
|
+
url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
|
|
164
|
+
protoPath: '/v1/sender-details',
|
|
165
|
+
data: payload,
|
|
166
|
+
host,
|
|
167
|
+
}),
|
|
168
|
+
params: toURLSearchParams(payload),
|
|
169
|
+
transformResponse: (payload) => transformPaths(payload, [
|
|
170
|
+
{
|
|
171
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
172
|
+
paths: [{ path: 'senderDetails.dateVerified' }],
|
|
173
|
+
},
|
|
174
|
+
]),
|
|
175
|
+
};
|
|
176
|
+
return metadata;
|
|
177
|
+
}
|
|
178
|
+
return __get;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Updates sender details.
|
|
182
|
+
*
|
|
183
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
184
|
+
*
|
|
185
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
186
|
+
* @deprecated It has been replaced with wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail(), and will be removed on 2025-09-30.
|
|
187
|
+
*/
|
|
188
|
+
export function update(payload) {
|
|
189
|
+
function __update({ host }) {
|
|
190
|
+
const serializedData = transformPaths(payload, [
|
|
191
|
+
{
|
|
192
|
+
transformFn: transformSDKTimestampToRESTTimestamp,
|
|
193
|
+
paths: [{ path: 'senderDetails.dateVerified' }],
|
|
194
|
+
},
|
|
195
|
+
]);
|
|
196
|
+
const metadata = {
|
|
197
|
+
entityFqdn: 'wix.email_marketing.v1.sender_details',
|
|
198
|
+
method: 'PATCH',
|
|
199
|
+
methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.Update',
|
|
200
|
+
packageName: PACKAGE_NAME,
|
|
201
|
+
url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
|
|
202
|
+
protoPath: '/v1/sender-details',
|
|
203
|
+
data: serializedData,
|
|
204
|
+
host,
|
|
205
|
+
}),
|
|
206
|
+
data: serializedData,
|
|
207
|
+
};
|
|
208
|
+
return metadata;
|
|
209
|
+
}
|
|
210
|
+
return __update;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
214
|
+
* @deprecated It has been replaced with wix.promote.v1.SenderEmailService.VerifySenderEmail(), and will be removed on 2025-09-30.
|
|
215
|
+
*/
|
|
216
|
+
export function verifyEmail(payload) {
|
|
217
|
+
function __verifyEmail({ host }) {
|
|
218
|
+
const metadata = {
|
|
219
|
+
entityFqdn: 'wix.email_marketing.v1.sender_details',
|
|
220
|
+
method: 'POST',
|
|
221
|
+
methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail',
|
|
222
|
+
packageName: PACKAGE_NAME,
|
|
223
|
+
url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
|
|
224
|
+
protoPath: '/v1/sender-details/verify-email',
|
|
225
|
+
data: payload,
|
|
226
|
+
host,
|
|
227
|
+
}),
|
|
228
|
+
data: payload,
|
|
229
|
+
};
|
|
230
|
+
return metadata;
|
|
231
|
+
}
|
|
232
|
+
return __verifyEmail;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
236
|
+
* @deprecated It has been replaced with wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress(), and will be removed on 2025-09-30.
|
|
237
|
+
*/
|
|
238
|
+
export function resolveActualFromAddress(payload) {
|
|
239
|
+
function __resolveActualFromAddress({ host }) {
|
|
240
|
+
const metadata = {
|
|
241
|
+
entityFqdn: 'wix.email_marketing.v1.sender_details',
|
|
242
|
+
method: 'POST',
|
|
243
|
+
methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress',
|
|
244
|
+
packageName: PACKAGE_NAME,
|
|
245
|
+
url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
|
|
246
|
+
protoPath: '/v1/sender-details/actual-from-address',
|
|
247
|
+
data: payload,
|
|
248
|
+
host,
|
|
249
|
+
}),
|
|
250
|
+
data: payload,
|
|
251
|
+
};
|
|
252
|
+
return metadata;
|
|
253
|
+
}
|
|
254
|
+
return __resolveActualFromAddress;
|
|
255
|
+
}
|
|
256
|
+
//# sourceMappingURL=email-marketing-v1-sender-details-sender-details.http.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.http.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAI3D,SAAS,oDAAoD,CAC3D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,wBAAwB,EAAE;YACxB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,8BAA8B,EAAE;YAC9B;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,UAAU,EAAE;YACV;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,YAAY,EAAE;YACZ;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,MAAM;aACjB;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,8CAA8C,CAAC;AAEpE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,GAAG,CAAC,OAAe;IACjC,SAAS,KAAK,CAAC,EAAE,IAAI,EAAO;QAC1B,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uCAAuC;YACnD,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC;iBAChD;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,MAAM,CAAC,OAAe;IACpC,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAO;QAC7B,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC;aAChD;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uCAAuC;YACnD,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,uDAAuD;YAClE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uCAAuC;YACnD,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,4DAA4D;YACvE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe;IAEf,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uCAAuC;YACnD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,yEAAyE;YAC3E,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,wCAAwC;gBACnD,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,0BAA0B,CAAC;AACpC,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import * as ambassadorWixEmailMarketingV1SenderDetailsTypes from './email-marketing-v1-sender-details-sender-details.types.js';
|
|
2
|
+
import * as ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
3
|
+
export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4
|
+
getUrl: (context: any) => string;
|
|
5
|
+
httpMethod: K;
|
|
6
|
+
path: string;
|
|
7
|
+
pathParams: M;
|
|
8
|
+
__requestType: T;
|
|
9
|
+
__originalRequestType: S;
|
|
10
|
+
__responseType: Q;
|
|
11
|
+
__originalResponseType: R;
|
|
12
|
+
};
|
|
13
|
+
export declare function getSenderDetails(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.GetSenderDetailsRequest, ambassadorWixEmailMarketingV1SenderDetailsTypes.GetSenderDetailsRequest, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.GetSenderDetailsResponse & ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.GetSenderDetailsResponseNonNullableFields, ambassadorWixEmailMarketingV1SenderDetailsTypes.GetSenderDetailsResponse & ambassadorWixEmailMarketingV1SenderDetailsTypes.GetSenderDetailsResponseNonNullableFields>;
|
|
14
|
+
export declare function updateSenderDetails(): __PublicMethodMetaInfo<'PATCH', {}, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.UpdateSenderDetailsRequest, ambassadorWixEmailMarketingV1SenderDetailsTypes.UpdateSenderDetailsRequest, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.UpdateSenderDetailsResponse & ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.UpdateSenderDetailsResponseNonNullableFields, ambassadorWixEmailMarketingV1SenderDetailsTypes.UpdateSenderDetailsResponse & ambassadorWixEmailMarketingV1SenderDetailsTypes.UpdateSenderDetailsResponseNonNullableFields>;
|
|
15
|
+
export declare function verifyEmail(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.VerifySenderEmailRequest, ambassadorWixEmailMarketingV1SenderDetailsTypes.VerifySenderEmailRequest, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.VerifySenderEmailResponse, ambassadorWixEmailMarketingV1SenderDetailsTypes.VerifySenderEmailResponse>;
|
|
16
|
+
export declare function resolveActualFromAddress(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.ResolveActualFromAddressRequest, ambassadorWixEmailMarketingV1SenderDetailsTypes.ResolveActualFromAddressRequest, ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.ResolveActualFromAddressResponse & ambassadorWixEmailMarketingV1SenderDetailsUniversalTypes.ResolveActualFromAddressResponseNonNullableFields, ambassadorWixEmailMarketingV1SenderDetailsTypes.ResolveActualFromAddressResponse & ambassadorWixEmailMarketingV1SenderDetailsTypes.ResolveActualFromAddressResponseNonNullableFields>;
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import * as ambassadorWixEmailMarketingV1SenderDetails from './email-marketing-v1-sender-details-sender-details.http.js';
|
|
2
|
+
export function getSenderDetails() {
|
|
3
|
+
const payload = {};
|
|
4
|
+
const getRequestOptions = ambassadorWixEmailMarketingV1SenderDetails.get(payload);
|
|
5
|
+
const getUrl = (context) => {
|
|
6
|
+
const { url } = getRequestOptions(context);
|
|
7
|
+
return url;
|
|
8
|
+
};
|
|
9
|
+
return {
|
|
10
|
+
getUrl,
|
|
11
|
+
httpMethod: 'GET',
|
|
12
|
+
path: '/v1/sender-details',
|
|
13
|
+
pathParams: {},
|
|
14
|
+
__requestType: null,
|
|
15
|
+
__originalRequestType: null,
|
|
16
|
+
__responseType: null,
|
|
17
|
+
__originalResponseType: null,
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
export function updateSenderDetails() {
|
|
21
|
+
const payload = {};
|
|
22
|
+
const getRequestOptions = ambassadorWixEmailMarketingV1SenderDetails.update(payload);
|
|
23
|
+
const getUrl = (context) => {
|
|
24
|
+
const { url } = getRequestOptions(context);
|
|
25
|
+
return url;
|
|
26
|
+
};
|
|
27
|
+
return {
|
|
28
|
+
getUrl,
|
|
29
|
+
httpMethod: 'PATCH',
|
|
30
|
+
path: '/v1/sender-details',
|
|
31
|
+
pathParams: {},
|
|
32
|
+
__requestType: null,
|
|
33
|
+
__originalRequestType: null,
|
|
34
|
+
__responseType: null,
|
|
35
|
+
__originalResponseType: null,
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
export function verifyEmail() {
|
|
39
|
+
const payload = {};
|
|
40
|
+
const getRequestOptions = ambassadorWixEmailMarketingV1SenderDetails.verifyEmail(payload);
|
|
41
|
+
const getUrl = (context) => {
|
|
42
|
+
const { url } = getRequestOptions(context);
|
|
43
|
+
return url;
|
|
44
|
+
};
|
|
45
|
+
return {
|
|
46
|
+
getUrl,
|
|
47
|
+
httpMethod: 'POST',
|
|
48
|
+
path: '/v1/sender-details/verify-email',
|
|
49
|
+
pathParams: {},
|
|
50
|
+
__requestType: null,
|
|
51
|
+
__originalRequestType: null,
|
|
52
|
+
__responseType: null,
|
|
53
|
+
__originalResponseType: null,
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
export function resolveActualFromAddress() {
|
|
57
|
+
const payload = {};
|
|
58
|
+
const getRequestOptions = ambassadorWixEmailMarketingV1SenderDetails.resolveActualFromAddress(payload);
|
|
59
|
+
const getUrl = (context) => {
|
|
60
|
+
const { url } = getRequestOptions(context);
|
|
61
|
+
return url;
|
|
62
|
+
};
|
|
63
|
+
return {
|
|
64
|
+
getUrl,
|
|
65
|
+
httpMethod: 'POST',
|
|
66
|
+
path: '/v1/sender-details/actual-from-address',
|
|
67
|
+
pathParams: {},
|
|
68
|
+
__requestType: null,
|
|
69
|
+
__originalRequestType: null,
|
|
70
|
+
__responseType: null,
|
|
71
|
+
__originalResponseType: null,
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=email-marketing-v1-sender-details-sender-details.meta.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.meta.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,0CAA0C,MAAM,4DAA4D,CAAC;AAsBzH,MAAM,UAAU,gBAAgB;IAU9B,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE1D,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB;IAUjC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,OAAO;QACnB,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW;IAQzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,iCAAiC;QACvC,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB;IAUtC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,wCAAwC;QAC9C,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { EventDefinition, HttpClient } from '@wix/sdk-types';
|
|
2
|
+
import { GetSenderDetailsResponse, GetSenderDetailsResponseNonNullableFields, ResolveActualFromAddressResponse, ResolveActualFromAddressResponseNonNullableFields, SenderDetails, SenderDetailsUpdatedEnvelope, UpdateSenderDetailsResponse, UpdateSenderDetailsResponseNonNullableFields } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
3
|
+
export declare const __metadata: {
|
|
4
|
+
PACKAGE_NAME: string;
|
|
5
|
+
};
|
|
6
|
+
export declare function getSenderDetails(httpClient: HttpClient): GetSenderDetailsSignature;
|
|
7
|
+
interface GetSenderDetailsSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves sender details.
|
|
10
|
+
*
|
|
11
|
+
* The sender details include the information displayed as the email sender's name and email address.
|
|
12
|
+
*
|
|
13
|
+
* + If you send an email campaign with a public email domain (e.g.
|
|
14
|
+
* @deprecated
|
|
15
|
+
*/
|
|
16
|
+
(): Promise<GetSenderDetailsResponse & GetSenderDetailsResponseNonNullableFields>;
|
|
17
|
+
}
|
|
18
|
+
export declare function updateSenderDetails(httpClient: HttpClient): UpdateSenderDetailsSignature;
|
|
19
|
+
interface UpdateSenderDetailsSignature {
|
|
20
|
+
/**
|
|
21
|
+
* Updates sender details.
|
|
22
|
+
*
|
|
23
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
24
|
+
*
|
|
25
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
26
|
+
*
|
|
27
|
+
* @param - New sender details.
|
|
28
|
+
* @deprecated
|
|
29
|
+
*/
|
|
30
|
+
(senderDetails: SenderDetails): Promise<UpdateSenderDetailsResponse & UpdateSenderDetailsResponseNonNullableFields>;
|
|
31
|
+
}
|
|
32
|
+
export declare function verifyEmail(httpClient: HttpClient): VerifyEmailSignature;
|
|
33
|
+
interface VerifyEmailSignature {
|
|
34
|
+
/**
|
|
35
|
+
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
36
|
+
* @param - Verification code.
|
|
37
|
+
* @deprecated
|
|
38
|
+
*/
|
|
39
|
+
(verificationCode: string): Promise<void>;
|
|
40
|
+
}
|
|
41
|
+
export declare function resolveActualFromAddress(httpClient: HttpClient): ResolveActualFromAddressSignature;
|
|
42
|
+
interface ResolveActualFromAddressSignature {
|
|
43
|
+
/**
|
|
44
|
+
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
45
|
+
* @param - User's provided address from which to send email marketing campaign.
|
|
46
|
+
* @deprecated
|
|
47
|
+
*/
|
|
48
|
+
(fromAddress: string): Promise<ResolveActualFromAddressResponse & ResolveActualFromAddressResponseNonNullableFields>;
|
|
49
|
+
}
|
|
50
|
+
export declare const onSenderDetailsUpdated: EventDefinition<SenderDetailsUpdatedEnvelope, "wix.email_marketing.v1.sender_details_updated">;
|
|
51
|
+
export { ActionEvent, BaseEventMetadata, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetSenderDetailsRequest, GetSenderDetailsResponse, GetSenderDetailsResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, ResolveActualFromAddressRequest, ResolveActualFromAddressResponse, ResolveActualFromAddressResponseNonNullableFields, RestoreInfo, SenderDetails, SenderDetailsUpdatedEnvelope, UpdateSenderDetailsRequest, UpdateSenderDetailsResponse, UpdateSenderDetailsResponseNonNullableFields, VerifySenderEmailRequest, VerifySenderEmailResponse, WebhookIdentityType, } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
|
|
2
|
+
import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
|
|
3
|
+
import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
|
|
4
|
+
import { EventDefinition } from '@wix/sdk-types';
|
|
5
|
+
import { getSenderDetails as universalGetSenderDetails, resolveActualFromAddress as universalResolveActualFromAddress, updateSenderDetails as universalUpdateSenderDetails, verifyEmail as universalVerifyEmail, } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
6
|
+
export const __metadata = { PACKAGE_NAME: '@wix/email-marketing' };
|
|
7
|
+
export function getSenderDetails(httpClient) {
|
|
8
|
+
return () => universalGetSenderDetails(
|
|
9
|
+
// @ts-ignore
|
|
10
|
+
{ httpClient });
|
|
11
|
+
}
|
|
12
|
+
export function updateSenderDetails(httpClient) {
|
|
13
|
+
return (senderDetails) => universalUpdateSenderDetails(senderDetails,
|
|
14
|
+
// @ts-ignore
|
|
15
|
+
{ httpClient });
|
|
16
|
+
}
|
|
17
|
+
export function verifyEmail(httpClient) {
|
|
18
|
+
return (verificationCode) => universalVerifyEmail(verificationCode,
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
{ httpClient });
|
|
21
|
+
}
|
|
22
|
+
export function resolveActualFromAddress(httpClient) {
|
|
23
|
+
return (fromAddress) => universalResolveActualFromAddress(fromAddress,
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
{ httpClient });
|
|
26
|
+
}
|
|
27
|
+
export const onSenderDetailsUpdated = EventDefinition('wix.email_marketing.v1.sender_details_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
|
28
|
+
{
|
|
29
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
30
|
+
paths: [
|
|
31
|
+
{ path: 'entity.dateVerified' },
|
|
32
|
+
{ path: 'metadata.eventTime' },
|
|
33
|
+
],
|
|
34
|
+
},
|
|
35
|
+
])))();
|
|
36
|
+
export { WebhookIdentityType, } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
37
|
+
//# sourceMappingURL=email-marketing-v1-sender-details-sender-details.public.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.public.js","sourceRoot":"","sources":["../../../../src/email-marketing-v1-sender-details-sender-details.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EASL,gBAAgB,IAAI,yBAAyB,EAC7C,wBAAwB,IAAI,iCAAiC,EAC7D,mBAAmB,IAAI,4BAA4B,EACnD,WAAW,IAAI,oBAAoB,GACpC,MAAM,iEAAiE,CAAC;AAEzE,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC;AAEnE,MAAM,UAAU,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,yBAAyB;IACvB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,aAA4B,EAAE,EAAE,CACtC,4BAA4B,CAC1B,aAAa;IACb,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAkBD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,oBAAoB,CAClB,gBAAgB;IAChB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,WAAmB,EAAE,EAAE,CAC7B,iCAAiC,CAC/B,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CACnD,+CAA+C,EAC/C,IAAI,EACJ,CAAC,KAAmC,EAAE,EAAE,CACtC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;YAC/B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAgC,CAAC;AAElC,OAAO,EA0BL,mBAAmB,GACpB,MAAM,iEAAiE,CAAC"}
|
|
@@ -0,0 +1,175 @@
|
|
|
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
|
+
entityAsJson?: string;
|
|
101
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
102
|
+
restoreInfo?: RestoreInfo;
|
|
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
|
+
currentEntityAsJson?: string;
|
|
114
|
+
}
|
|
115
|
+
export interface EntityDeletedEvent {
|
|
116
|
+
/** Entity that was deleted */
|
|
117
|
+
deletedEntityAsJson?: string | null;
|
|
118
|
+
}
|
|
119
|
+
export interface ActionEvent {
|
|
120
|
+
bodyAsJson?: string;
|
|
121
|
+
}
|
|
122
|
+
export interface MessageEnvelope {
|
|
123
|
+
/** App instance ID. */
|
|
124
|
+
instanceId?: string | null;
|
|
125
|
+
/** Event type. */
|
|
126
|
+
eventType?: string;
|
|
127
|
+
/** The identification type and identity data. */
|
|
128
|
+
identity?: IdentificationData;
|
|
129
|
+
/** Stringify payload. */
|
|
130
|
+
data?: string;
|
|
131
|
+
}
|
|
132
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
133
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
134
|
+
anonymousVisitorId?: string;
|
|
135
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
136
|
+
memberId?: string;
|
|
137
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
138
|
+
wixUserId?: string;
|
|
139
|
+
/** ID of an app. */
|
|
140
|
+
appId?: string;
|
|
141
|
+
/** @readonly */
|
|
142
|
+
identityType?: WebhookIdentityType;
|
|
143
|
+
}
|
|
144
|
+
/** @oneof */
|
|
145
|
+
export interface IdentificationDataIdOneOf {
|
|
146
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
147
|
+
anonymousVisitorId?: string;
|
|
148
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
149
|
+
memberId?: string;
|
|
150
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
151
|
+
wixUserId?: string;
|
|
152
|
+
/** ID of an app. */
|
|
153
|
+
appId?: string;
|
|
154
|
+
}
|
|
155
|
+
export declare enum WebhookIdentityType {
|
|
156
|
+
UNKNOWN = "UNKNOWN",
|
|
157
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
158
|
+
MEMBER = "MEMBER",
|
|
159
|
+
WIX_USER = "WIX_USER",
|
|
160
|
+
APP = "APP"
|
|
161
|
+
}
|
|
162
|
+
interface SenderDetailsNonNullableFields {
|
|
163
|
+
fromName: string;
|
|
164
|
+
fromEmail: string;
|
|
165
|
+
}
|
|
166
|
+
export interface GetSenderDetailsResponseNonNullableFields {
|
|
167
|
+
senderDetails?: SenderDetailsNonNullableFields;
|
|
168
|
+
}
|
|
169
|
+
export interface UpdateSenderDetailsResponseNonNullableFields {
|
|
170
|
+
verificationNeeded: boolean;
|
|
171
|
+
}
|
|
172
|
+
export interface ResolveActualFromAddressResponseNonNullableFields {
|
|
173
|
+
actualFromAddress: string;
|
|
174
|
+
}
|
|
175
|
+
export {};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export var WebhookIdentityType;
|
|
2
|
+
(function (WebhookIdentityType) {
|
|
3
|
+
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
4
|
+
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
5
|
+
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
6
|
+
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
7
|
+
WebhookIdentityType["APP"] = "APP";
|
|
8
|
+
})(WebhookIdentityType || (WebhookIdentityType = {}));
|
|
9
|
+
//# sourceMappingURL=email-marketing-v1-sender-details-sender-details.types.js.map
|
|
@@ -0,0 +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"}
|