@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,198 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.resolveActualFromAddress = exports.verifyEmail = exports.updateSenderDetails = exports.getSenderDetails = exports.WebhookIdentityType = void 0;
|
|
27
|
+
const transform_error_1 = require("@wix/sdk-runtime/transform-error");
|
|
28
|
+
const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
|
|
29
|
+
const ambassadorWixEmailMarketingV1SenderDetails = __importStar(require("./email-marketing-v1-sender-details-sender-details.http.js"));
|
|
30
|
+
var WebhookIdentityType;
|
|
31
|
+
(function (WebhookIdentityType) {
|
|
32
|
+
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
33
|
+
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
34
|
+
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
35
|
+
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
36
|
+
WebhookIdentityType["APP"] = "APP";
|
|
37
|
+
})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
|
|
38
|
+
/**
|
|
39
|
+
* Retrieves sender details.
|
|
40
|
+
*
|
|
41
|
+
* The sender details include the information displayed as the email sender's name and email address.
|
|
42
|
+
*
|
|
43
|
+
* + 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.
|
|
44
|
+
*
|
|
45
|
+
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
46
|
+
*
|
|
47
|
+
* + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
|
|
48
|
+
* @public
|
|
49
|
+
* @permissionId Shoutout.Manage
|
|
50
|
+
* @permissionScope Manage Email Marketing
|
|
51
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
52
|
+
* @applicableIdentity APP
|
|
53
|
+
* @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get
|
|
54
|
+
* @deprecated
|
|
55
|
+
* @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails
|
|
56
|
+
* @targetRemovalDate 2025-09-30
|
|
57
|
+
*/
|
|
58
|
+
async function getSenderDetails() {
|
|
59
|
+
// @ts-ignore
|
|
60
|
+
const { httpClient, sideEffects } = arguments[0];
|
|
61
|
+
const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({});
|
|
62
|
+
const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.get(payload);
|
|
63
|
+
sideEffects?.onSiteCall?.();
|
|
64
|
+
try {
|
|
65
|
+
const result = await httpClient.request(reqOpts);
|
|
66
|
+
sideEffects?.onSuccess?.(result);
|
|
67
|
+
return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
|
|
68
|
+
}
|
|
69
|
+
catch (err) {
|
|
70
|
+
const transformedError = (0, transform_error_1.transformError)(err, {
|
|
71
|
+
spreadPathsToArguments: {},
|
|
72
|
+
explicitPathsToArguments: {},
|
|
73
|
+
singleArgumentUnchanged: false,
|
|
74
|
+
}, []);
|
|
75
|
+
sideEffects?.onError?.(err);
|
|
76
|
+
throw transformedError;
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
exports.getSenderDetails = getSenderDetails;
|
|
80
|
+
/**
|
|
81
|
+
* Updates sender details.
|
|
82
|
+
*
|
|
83
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
84
|
+
*
|
|
85
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
86
|
+
*
|
|
87
|
+
* @param senderDetails - New sender details.
|
|
88
|
+
* @public
|
|
89
|
+
* @requiredField senderDetails
|
|
90
|
+
* @permissionId Shoutout.Manage
|
|
91
|
+
* @permissionScope Manage Email Marketing
|
|
92
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
93
|
+
* @applicableIdentity APP
|
|
94
|
+
* @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update
|
|
95
|
+
* @deprecated
|
|
96
|
+
* @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail
|
|
97
|
+
* @targetRemovalDate 2025-09-30
|
|
98
|
+
*/
|
|
99
|
+
async function updateSenderDetails(senderDetails) {
|
|
100
|
+
// @ts-ignore
|
|
101
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
102
|
+
const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
|
|
103
|
+
senderDetails: senderDetails,
|
|
104
|
+
});
|
|
105
|
+
const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.update(payload);
|
|
106
|
+
sideEffects?.onSiteCall?.();
|
|
107
|
+
try {
|
|
108
|
+
const result = await httpClient.request(reqOpts);
|
|
109
|
+
sideEffects?.onSuccess?.(result);
|
|
110
|
+
return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
|
|
111
|
+
}
|
|
112
|
+
catch (err) {
|
|
113
|
+
const transformedError = (0, transform_error_1.transformError)(err, {
|
|
114
|
+
spreadPathsToArguments: {},
|
|
115
|
+
explicitPathsToArguments: { senderDetails: '$[0]' },
|
|
116
|
+
singleArgumentUnchanged: false,
|
|
117
|
+
}, ['senderDetails']);
|
|
118
|
+
sideEffects?.onError?.(err);
|
|
119
|
+
throw transformedError;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
exports.updateSenderDetails = updateSenderDetails;
|
|
123
|
+
/**
|
|
124
|
+
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
125
|
+
* @param verificationCode - Verification code.
|
|
126
|
+
* @public
|
|
127
|
+
* @requiredField verificationCode
|
|
128
|
+
* @permissionId Shoutout.Manage
|
|
129
|
+
* @permissionScope Manage Email Marketing
|
|
130
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
131
|
+
* @applicableIdentity APP
|
|
132
|
+
* @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail
|
|
133
|
+
* @deprecated
|
|
134
|
+
* @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail
|
|
135
|
+
* @targetRemovalDate 2025-09-30
|
|
136
|
+
*/
|
|
137
|
+
async function verifyEmail(verificationCode) {
|
|
138
|
+
// @ts-ignore
|
|
139
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
140
|
+
const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
|
|
141
|
+
verificationCode: verificationCode,
|
|
142
|
+
});
|
|
143
|
+
const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.verifyEmail(payload);
|
|
144
|
+
sideEffects?.onSiteCall?.();
|
|
145
|
+
try {
|
|
146
|
+
const result = await httpClient.request(reqOpts);
|
|
147
|
+
sideEffects?.onSuccess?.(result);
|
|
148
|
+
}
|
|
149
|
+
catch (err) {
|
|
150
|
+
const transformedError = (0, transform_error_1.transformError)(err, {
|
|
151
|
+
spreadPathsToArguments: {},
|
|
152
|
+
explicitPathsToArguments: { verificationCode: '$[0]' },
|
|
153
|
+
singleArgumentUnchanged: false,
|
|
154
|
+
}, ['verificationCode']);
|
|
155
|
+
sideEffects?.onError?.(err);
|
|
156
|
+
throw transformedError;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
exports.verifyEmail = verifyEmail;
|
|
160
|
+
/**
|
|
161
|
+
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
162
|
+
* @param fromAddress - User's provided address from which to send email marketing campaign.
|
|
163
|
+
* @public
|
|
164
|
+
* @requiredField fromAddress
|
|
165
|
+
* @permissionId Shoutout.Manage
|
|
166
|
+
* @permissionScope Manage Email Marketing
|
|
167
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
168
|
+
* @applicableIdentity APP
|
|
169
|
+
* @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress
|
|
170
|
+
* @deprecated
|
|
171
|
+
* @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
|
|
172
|
+
* @targetRemovalDate 2025-09-30
|
|
173
|
+
*/
|
|
174
|
+
async function resolveActualFromAddress(fromAddress) {
|
|
175
|
+
// @ts-ignore
|
|
176
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
177
|
+
const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
|
|
178
|
+
fromAddress: fromAddress,
|
|
179
|
+
});
|
|
180
|
+
const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.resolveActualFromAddress(payload);
|
|
181
|
+
sideEffects?.onSiteCall?.();
|
|
182
|
+
try {
|
|
183
|
+
const result = await httpClient.request(reqOpts);
|
|
184
|
+
sideEffects?.onSuccess?.(result);
|
|
185
|
+
return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
|
|
186
|
+
}
|
|
187
|
+
catch (err) {
|
|
188
|
+
const transformedError = (0, transform_error_1.transformError)(err, {
|
|
189
|
+
spreadPathsToArguments: {},
|
|
190
|
+
explicitPathsToArguments: { fromAddress: '$[0]' },
|
|
191
|
+
singleArgumentUnchanged: false,
|
|
192
|
+
}, ['fromAddress']);
|
|
193
|
+
sideEffects?.onError?.(err);
|
|
194
|
+
throw transformedError;
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
exports.resolveActualFromAddress = resolveActualFromAddress;
|
|
198
|
+
//# 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,sEAAuF;AACvF,oFAGiD;AAEjD,uIAAyH;AA2KzH,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsFD;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,gBAAgB;IAGpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAjCD,4CAiCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,mBAAmB,CACvC,aAA4B;IAI5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,kDAqCC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,WAAW,CAAC,gBAAwB;IACxD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAhCD,kCAgCC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAmB;IAKnB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAzCD,4DAyCC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './src/email-marketing-v1-sender-details-sender-details.context.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,mEAAmE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './src/email-marketing-v1-sender-details-sender-details.universal.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":"AAAA,cAAc,qEAAqE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './src/email-marketing-v1-sender-details-sender-details.meta.js';
|
package/build/es/meta.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,cAAc,gEAAgE,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { getSenderDetails as publicGetSenderDetails, updateSenderDetails as publicUpdateSenderDetails, verifyEmail as publicVerifyEmail, resolveActualFromAddress as publicResolveActualFromAddress } from './email-marketing-v1-sender-details-sender-details.public.js';
|
|
2
|
+
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
|
|
3
|
+
import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
|
|
4
|
+
import { onSenderDetailsUpdated as publicOnSenderDetailsUpdated } from './email-marketing-v1-sender-details-sender-details.public.js';
|
|
5
|
+
export declare const getSenderDetails: MaybeContext<BuildRESTFunction<typeof publicGetSenderDetails> & typeof publicGetSenderDetails>;
|
|
6
|
+
export declare const updateSenderDetails: MaybeContext<BuildRESTFunction<typeof publicUpdateSenderDetails> & typeof publicUpdateSenderDetails>;
|
|
7
|
+
export declare const verifyEmail: MaybeContext<BuildRESTFunction<typeof publicVerifyEmail> & typeof publicVerifyEmail>;
|
|
8
|
+
export declare const resolveActualFromAddress: MaybeContext<BuildRESTFunction<typeof publicResolveActualFromAddress> & typeof publicResolveActualFromAddress>;
|
|
9
|
+
/**
|
|
10
|
+
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
11
|
+
*/
|
|
12
|
+
export declare const onSenderDetailsUpdated: ReturnType<typeof createEventModule<typeof publicOnSenderDetailsUpdated>>;
|
|
13
|
+
export { WebhookIdentityType } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
14
|
+
export { SenderDetails, GetSenderDetailsRequest, GetSenderDetailsResponse, UpdateSenderDetailsRequest, UpdateSenderDetailsResponse, VerifySenderEmailRequest, VerifySenderEmailResponse, ResolveActualFromAddressRequest, ResolveActualFromAddressResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, GetSenderDetailsResponseNonNullableFields, UpdateSenderDetailsResponseNonNullableFields, ResolveActualFromAddressResponseNonNullableFields, BaseEventMetadata, EventMetadata, SenderDetailsUpdatedEnvelope, } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { getSenderDetails as publicGetSenderDetails, updateSenderDetails as publicUpdateSenderDetails, verifyEmail as publicVerifyEmail, resolveActualFromAddress as publicResolveActualFromAddress, } from './email-marketing-v1-sender-details-sender-details.public.js';
|
|
2
|
+
import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
|
|
3
|
+
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
|
|
4
|
+
import { onSenderDetailsUpdated as publicOnSenderDetailsUpdated } from './email-marketing-v1-sender-details-sender-details.public.js';
|
|
5
|
+
export const getSenderDetails = /*#__PURE__*/ createRESTModule(publicGetSenderDetails);
|
|
6
|
+
export const updateSenderDetails = /*#__PURE__*/ createRESTModule(publicUpdateSenderDetails);
|
|
7
|
+
export const verifyEmail = /*#__PURE__*/ createRESTModule(publicVerifyEmail);
|
|
8
|
+
export const resolveActualFromAddress = /*#__PURE__*/ createRESTModule(publicResolveActualFromAddress);
|
|
9
|
+
/**
|
|
10
|
+
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
11
|
+
*/
|
|
12
|
+
export const onSenderDetailsUpdated = createEventModule(publicOnSenderDetailsUpdated);
|
|
13
|
+
export { WebhookIdentityType } from './email-marketing-v1-sender-details-sender-details.universal.js';
|
|
14
|
+
//# sourceMappingURL=email-marketing-v1-sender-details-sender-details.context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details-sender-details.context.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details-sender-details.context.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,IAAI,sBAAsB,EAC1C,mBAAmB,IAAI,yBAAyB,EAChD,WAAW,IAAI,iBAAiB,EAChC,wBAAwB,IAAI,8BAA8B,GAC3D,MAAM,8DAA8D,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAE9E,OAAO,EAAE,sBAAsB,IAAI,4BAA4B,EAAE,MAAM,8DAA8D,CAAC;AAEtI,MAAM,CAAC,MAAM,gBAAgB,GAGzB,aAAa,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,mBAAmB,GAG5B,aAAa,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;AAC9D,MAAM,CAAC,MAAM,WAAW,GAEpB,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AACtD,MAAM,CAAC,MAAM,wBAAwB,GAGjC,aAAa,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;AACnE;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAE/B,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;AAEpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iEAAiE,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
+
/**
|
|
3
|
+
* Retrieves sender details.
|
|
4
|
+
*
|
|
5
|
+
* The sender details include the information displayed as the email sender's name and email address.
|
|
6
|
+
*
|
|
7
|
+
* + 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.
|
|
8
|
+
*
|
|
9
|
+
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
10
|
+
*
|
|
11
|
+
* + 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.
|
|
12
|
+
* @deprecated It has been replaced with wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails(), and will be removed on 2025-09-30.
|
|
13
|
+
*/
|
|
14
|
+
export declare function get(payload: object): RequestOptionsFactory<any>;
|
|
15
|
+
/**
|
|
16
|
+
* Updates sender details.
|
|
17
|
+
*
|
|
18
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
19
|
+
*
|
|
20
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
21
|
+
* @deprecated It has been replaced with wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail(), and will be removed on 2025-09-30.
|
|
22
|
+
*/
|
|
23
|
+
export declare function update(payload: object): RequestOptionsFactory<any>;
|
|
24
|
+
/**
|
|
25
|
+
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
26
|
+
* @deprecated It has been replaced with wix.promote.v1.SenderEmailService.VerifySenderEmail(), and will be removed on 2025-09-30.
|
|
27
|
+
*/
|
|
28
|
+
export declare function verifyEmail(payload: object): RequestOptionsFactory<any>;
|
|
29
|
+
/**
|
|
30
|
+
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
31
|
+
* @deprecated It has been replaced with wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress(), and will be removed on 2025-09-30.
|
|
32
|
+
*/
|
|
33
|
+
export declare function resolveActualFromAddress(payload: object): RequestOptionsFactory<any>;
|
|
@@ -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>;
|