@wix/email-marketing 1.0.10 → 1.0.11
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 -1
- package/build/cjs/index.js +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-sender-details.http.d.ts +16 -3
- package/build/cjs/src/email-marketing-v1-sender-details.http.js +16 -3
- package/build/cjs/src/email-marketing-v1-sender-details.http.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-sender-details.universal.d.ts +16 -3
- package/build/cjs/src/email-marketing-v1-sender-details.universal.js +16 -3
- package/build/cjs/src/email-marketing-v1-sender-details.universal.js.map +1 -1
- package/build/es/index.d.ts +1 -1
- package/build/es/index.js +1 -1
- package/build/es/index.js.map +1 -1
- package/build/es/src/email-marketing-v1-sender-details.http.d.ts +16 -3
- package/build/es/src/email-marketing-v1-sender-details.http.js +16 -3
- package/build/es/src/email-marketing-v1-sender-details.http.js.map +1 -1
- package/build/es/src/email-marketing-v1-sender-details.universal.d.ts +16 -3
- package/build/es/src/email-marketing-v1-sender-details.universal.js +16 -3
- package/build/es/src/email-marketing-v1-sender-details.universal.js.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export * as senderDetails from './src/email-marketing-v1-sender-details.public';
|
|
2
1
|
export * as accountDetails from './src/email-marketing-v1-account-details.public';
|
|
3
2
|
export * as campaigns from './src/email-marketing-v1-campaign.public';
|
|
3
|
+
export * as senderDetails from './src/email-marketing-v1-sender-details.public';
|
package/build/cjs/index.js
CHANGED
|
@@ -19,8 +19,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
19
19
|
return result;
|
|
20
20
|
};
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
-
exports.
|
|
23
|
-
exports.senderDetails = __importStar(require("./src/email-marketing-v1-sender-details.public"));
|
|
22
|
+
exports.senderDetails = exports.campaigns = exports.accountDetails = void 0;
|
|
24
23
|
exports.accountDetails = __importStar(require("./src/email-marketing-v1-account-details.public"));
|
|
25
24
|
exports.campaigns = __importStar(require("./src/email-marketing-v1-campaign.public"));
|
|
25
|
+
exports.senderDetails = __importStar(require("./src/email-marketing-v1-sender-details.public"));
|
|
26
26
|
//# sourceMappingURL=index.js.map
|
package/build/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,kGAAkF;AAClF,sFAAsE;AACtE,gGAAgF"}
|
|
@@ -6,26 +6,39 @@ import { GetSenderDetailsRequest, GetSenderDetailsResponse, ResolveActualFromAdd
|
|
|
6
6
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
7
7
|
*
|
|
8
8
|
* + 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.
|
|
9
|
+
*
|
|
9
10
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
11
|
+
*
|
|
10
12
|
* + 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.
|
|
13
|
+
*
|
|
14
|
+
*
|
|
15
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
11
16
|
*/
|
|
12
17
|
export declare function get(payload: GetSenderDetailsRequest): RequestOptionsFactory<GetSenderDetailsResponse>;
|
|
13
18
|
/**
|
|
14
|
-
* Updates sender details
|
|
19
|
+
* Updates sender details.
|
|
20
|
+
*
|
|
21
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
22
|
+
*
|
|
23
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
15
24
|
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
25
|
+
*
|
|
26
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
18
27
|
*/
|
|
19
28
|
export declare function update(payload: UpdateSenderDetailsRequest): RequestOptionsFactory<UpdateSenderDetailsResponse>;
|
|
20
29
|
/**
|
|
21
30
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
22
31
|
*
|
|
32
|
+
*
|
|
33
|
+
*
|
|
23
34
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
24
35
|
*/
|
|
25
36
|
export declare function verifyEmail(payload: VerifySenderEmailRequest): RequestOptionsFactory<VerifySenderEmailResponse>;
|
|
26
37
|
/**
|
|
27
38
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
28
39
|
*
|
|
40
|
+
*
|
|
41
|
+
*
|
|
29
42
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
30
43
|
*/
|
|
31
44
|
export declare function resolveActualFromAddress(payload: ResolveActualFromAddressRequest): RequestOptionsFactory<ResolveActualFromAddressResponse>;
|
|
@@ -132,8 +132,13 @@ function resolveWixEmailmarketingApiV1SenderDetailsServiceUrl(opts) {
|
|
|
132
132
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
133
133
|
*
|
|
134
134
|
* + 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.
|
|
135
|
+
*
|
|
135
136
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
137
|
+
*
|
|
136
138
|
* + 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.
|
|
139
|
+
*
|
|
140
|
+
*
|
|
141
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
137
142
|
*/
|
|
138
143
|
function get(payload) {
|
|
139
144
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getSenderDetailsRequest, {});
|
|
@@ -159,10 +164,14 @@ function get(payload) {
|
|
|
159
164
|
}
|
|
160
165
|
exports.get = get;
|
|
161
166
|
/**
|
|
162
|
-
* Updates sender details
|
|
167
|
+
* Updates sender details.
|
|
168
|
+
*
|
|
169
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
170
|
+
*
|
|
171
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
163
172
|
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
173
|
+
*
|
|
174
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
166
175
|
*/
|
|
167
176
|
function update(payload) {
|
|
168
177
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateSenderDetailsRequest, { _senderDetails });
|
|
@@ -188,6 +197,8 @@ exports.update = update;
|
|
|
188
197
|
/**
|
|
189
198
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
190
199
|
*
|
|
200
|
+
*
|
|
201
|
+
*
|
|
191
202
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
192
203
|
*/
|
|
193
204
|
function verifyEmail(payload) {
|
|
@@ -214,6 +225,8 @@ exports.verifyEmail = verifyEmail;
|
|
|
214
225
|
/**
|
|
215
226
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
216
227
|
*
|
|
228
|
+
*
|
|
229
|
+
*
|
|
217
230
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
218
231
|
*/
|
|
219
232
|
function resolveActualFromAddress(payload) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details.http.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACtE,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,cAAc,GAAG,EAAE,YAAY,EAAE,2BAA2B,EAAE,CAAC;AACrE,MAAM,2BAA2B,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACxE,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC,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;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details.http.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACtE,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,cAAc,GAAG,EAAE,YAAY,EAAE,2BAA2B,EAAE,CAAC;AACrE,MAAM,2BAA2B,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACxE,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC,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;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,GAAG,CACjB,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,yBAAyB,EAAE;QAClE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,KAAK,CAAC,EAAE,IAAI,EAAO;QAC1B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,KAAY;YACpB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IAExB,OAAO,KAAK,CAAC;AACf,CAAC;AA9BD,kBA8BC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM,CACpB,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,cAAc,EAAE,CACnB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAE3E,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAO;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,OAAc;YACtB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAE3B,OAAO,QAAQ,CAAC;AAClB,CAAC;AA5BD,wBA4BC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CACzB,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAEzE,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AA5BD,kCA4BC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,OAAwC;IAExC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,gCAAgC,EAChC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,iCAAiC,EACjC,EAAE,CACH,CAAC;IAEF,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,wCAAwC;gBACnD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,0BAA0B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7C,OAAO,0BAA0B,CAAC;AACpC,CAAC;AA/BD,4DA+BC"}
|
|
@@ -59,17 +59,26 @@ export interface ResolveActualFromAddressResponse {
|
|
|
59
59
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
60
60
|
*
|
|
61
61
|
* + 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.
|
|
62
|
+
*
|
|
62
63
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
64
|
+
*
|
|
63
65
|
* + 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.
|
|
66
|
+
*
|
|
67
|
+
*
|
|
68
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
64
69
|
* @public
|
|
65
70
|
* @documentationMaturity preview
|
|
66
71
|
*/
|
|
67
72
|
export declare function getSenderDetails(): Promise<GetSenderDetailsResponse>;
|
|
68
73
|
/**
|
|
69
|
-
* Updates sender details
|
|
74
|
+
* Updates sender details.
|
|
75
|
+
*
|
|
76
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
77
|
+
*
|
|
78
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
70
79
|
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
80
|
+
*
|
|
81
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
73
82
|
* @param senderDetails - New sender details.
|
|
74
83
|
* @public
|
|
75
84
|
* @documentationMaturity preview
|
|
@@ -79,6 +88,8 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
|
|
|
79
88
|
/**
|
|
80
89
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
81
90
|
*
|
|
91
|
+
*
|
|
92
|
+
*
|
|
82
93
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
83
94
|
* @param verificationCode - Verification code.
|
|
84
95
|
* @public
|
|
@@ -89,6 +100,8 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
|
|
|
89
100
|
/**
|
|
90
101
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
91
102
|
*
|
|
103
|
+
*
|
|
104
|
+
*
|
|
92
105
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
93
106
|
* @param fromAddress - User's provided address from which to send email marketing campaign.
|
|
94
107
|
* @public
|
|
@@ -60,8 +60,13 @@ const _verifySenderEmailResponse = {};
|
|
|
60
60
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
61
61
|
*
|
|
62
62
|
* + 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.
|
|
63
|
+
*
|
|
63
64
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
65
|
+
*
|
|
64
66
|
* + 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.
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
65
70
|
* @public
|
|
66
71
|
* @documentationMaturity preview
|
|
67
72
|
*/
|
|
@@ -108,10 +113,14 @@ function getSenderDetails() {
|
|
|
108
113
|
}
|
|
109
114
|
exports.getSenderDetails = getSenderDetails;
|
|
110
115
|
/**
|
|
111
|
-
* Updates sender details
|
|
116
|
+
* Updates sender details.
|
|
117
|
+
*
|
|
118
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
119
|
+
*
|
|
120
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
112
121
|
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
122
|
+
*
|
|
123
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
115
124
|
* @param senderDetails - New sender details.
|
|
116
125
|
* @public
|
|
117
126
|
* @documentationMaturity preview
|
|
@@ -164,6 +173,8 @@ exports.updateSenderDetails = updateSenderDetails;
|
|
|
164
173
|
/**
|
|
165
174
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
166
175
|
*
|
|
176
|
+
*
|
|
177
|
+
*
|
|
167
178
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
168
179
|
* @param verificationCode - Verification code.
|
|
169
180
|
* @public
|
|
@@ -217,6 +228,8 @@ exports.verifyEmail = verifyEmail;
|
|
|
217
228
|
/**
|
|
218
229
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
219
230
|
*
|
|
231
|
+
*
|
|
232
|
+
*
|
|
220
233
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
221
234
|
* @param fromAddress - User's provided address from which to send email marketing campaign.
|
|
222
235
|
* @public
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,qHAAuG;AAEvG,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0D5B,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,qHAAuG;AAEvG,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0D5B,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,SAAsB,gBAAgB;;;QACpC,MAAM,qBAAqB,GAAG,EAAE,CAAC;QACjC,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,wBAAwB;YACpC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC7B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,+BAA+B,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE3D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;YACxE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAhDD,4CAgDC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAsB,mBAAmB,CACvC,aAA4B;;;QAE5B,MAAM,qBAAqB,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;QACxD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,2BAA2B;YACvC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC7B,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,4BAA4B;YACxC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE3E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,eAAe;aAChB,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AApDD,kDAoDC;AAED;;;;;;;;;;GAUG;AACH,SAAsB,WAAW,CAAC,gBAAwB;;;QACxD,MAAM,qBAAqB,GAAG,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3D,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAExD,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAElE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,kBAAkB;aACnB,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAnDD,kCAmDC;AAED;;;;;;;;;;GAUG;AACH,SAAsB,wBAAwB,CAC5C,WAAmB;;;QAEnB,MAAM,qBAAqB,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;QACtD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,iCAAiC;YAC7C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QAEnD,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,oDAAoD,SAAS,CAAC,OAAO,CAAC,EAAE,CACzE,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,aAAa;aACd,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAzDD,4DAyDC"}
|
package/build/es/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export * as senderDetails from './src/email-marketing-v1-sender-details.public';
|
|
2
1
|
export * as accountDetails from './src/email-marketing-v1-account-details.public';
|
|
3
2
|
export * as campaigns from './src/email-marketing-v1-campaign.public';
|
|
3
|
+
export * as senderDetails from './src/email-marketing-v1-sender-details.public';
|
package/build/es/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export * as senderDetails from './src/email-marketing-v1-sender-details.public';
|
|
2
1
|
export * as accountDetails from './src/email-marketing-v1-account-details.public';
|
|
3
2
|
export * as campaigns from './src/email-marketing-v1-campaign.public';
|
|
3
|
+
export * as senderDetails from './src/email-marketing-v1-sender-details.public';
|
|
4
4
|
//# sourceMappingURL=index.js.map
|
package/build/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,cAAc,MAAM,iDAAiD,CAAC;AAClF,OAAO,KAAK,SAAS,MAAM,0CAA0C,CAAC;AACtE,OAAO,KAAK,aAAa,MAAM,gDAAgD,CAAC"}
|
|
@@ -6,26 +6,39 @@ import { GetSenderDetailsRequest, GetSenderDetailsResponse, ResolveActualFromAdd
|
|
|
6
6
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
7
7
|
*
|
|
8
8
|
* + 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.
|
|
9
|
+
*
|
|
9
10
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
11
|
+
*
|
|
10
12
|
* + 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.
|
|
13
|
+
*
|
|
14
|
+
*
|
|
15
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
11
16
|
*/
|
|
12
17
|
export declare function get(payload: GetSenderDetailsRequest): RequestOptionsFactory<GetSenderDetailsResponse>;
|
|
13
18
|
/**
|
|
14
|
-
* Updates sender details
|
|
19
|
+
* Updates sender details.
|
|
20
|
+
*
|
|
21
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
22
|
+
*
|
|
23
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
15
24
|
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
25
|
+
*
|
|
26
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
18
27
|
*/
|
|
19
28
|
export declare function update(payload: UpdateSenderDetailsRequest): RequestOptionsFactory<UpdateSenderDetailsResponse>;
|
|
20
29
|
/**
|
|
21
30
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
22
31
|
*
|
|
32
|
+
*
|
|
33
|
+
*
|
|
23
34
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
24
35
|
*/
|
|
25
36
|
export declare function verifyEmail(payload: VerifySenderEmailRequest): RequestOptionsFactory<VerifySenderEmailResponse>;
|
|
26
37
|
/**
|
|
27
38
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
28
39
|
*
|
|
40
|
+
*
|
|
41
|
+
*
|
|
29
42
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
30
43
|
*/
|
|
31
44
|
export declare function resolveActualFromAddress(payload: ResolveActualFromAddressRequest): RequestOptionsFactory<ResolveActualFromAddressResponse>;
|
|
@@ -129,8 +129,13 @@ function resolveWixEmailmarketingApiV1SenderDetailsServiceUrl(opts) {
|
|
|
129
129
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
130
130
|
*
|
|
131
131
|
* + 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.
|
|
132
|
+
*
|
|
132
133
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
134
|
+
*
|
|
133
135
|
* + 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.
|
|
136
|
+
*
|
|
137
|
+
*
|
|
138
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
134
139
|
*/
|
|
135
140
|
export function get(payload) {
|
|
136
141
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_getSenderDetailsRequest, {});
|
|
@@ -155,10 +160,14 @@ export function get(payload) {
|
|
|
155
160
|
return __get;
|
|
156
161
|
}
|
|
157
162
|
/**
|
|
158
|
-
* Updates sender details
|
|
163
|
+
* Updates sender details.
|
|
164
|
+
*
|
|
165
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
166
|
+
*
|
|
167
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
159
168
|
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
169
|
+
*
|
|
170
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
162
171
|
*/
|
|
163
172
|
export function update(payload) {
|
|
164
173
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_updateSenderDetailsRequest, { _senderDetails });
|
|
@@ -183,6 +192,8 @@ export function update(payload) {
|
|
|
183
192
|
/**
|
|
184
193
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
185
194
|
*
|
|
195
|
+
*
|
|
196
|
+
*
|
|
186
197
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
187
198
|
*/
|
|
188
199
|
export function verifyEmail(payload) {
|
|
@@ -208,6 +219,8 @@ export function verifyEmail(payload) {
|
|
|
208
219
|
/**
|
|
209
220
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
210
221
|
*
|
|
222
|
+
*
|
|
223
|
+
*
|
|
211
224
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
212
225
|
*/
|
|
213
226
|
export function resolveActualFromAddress(payload) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details.http.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAchD,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACtE,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,cAAc,GAAG,EAAE,YAAY,EAAE,2BAA2B,EAAE,CAAC;AACrE,MAAM,2BAA2B,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACxE,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC,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;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details.http.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAchD,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACtE,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,cAAc,GAAG,EAAE,YAAY,EAAE,2BAA2B,EAAE,CAAC;AACrE,MAAM,2BAA2B,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC;AACxE,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC,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;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAG,CACjB,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,yBAAyB,EAAE;QAClE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,KAAK,CAAC,EAAE,IAAI,EAAO;QAC1B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,KAAY;YACpB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IAExB,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CACpB,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,2BAA2B,EAC3B,EAAE,cAAc,EAAE,CACnB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAE3E,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAO;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,OAAc;YACtB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAE3B,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAEzE,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAwC;IAExC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,gCAAgC,EAChC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,iCAAiC,EACjC,EAAE,CACH,CAAC;IAEF,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,oDAAoD,CAAC;gBACxD,SAAS,EAAE,wCAAwC;gBACnD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,0BAA0B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7C,OAAO,0BAA0B,CAAC;AACpC,CAAC"}
|
|
@@ -59,17 +59,26 @@ export interface ResolveActualFromAddressResponse {
|
|
|
59
59
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
60
60
|
*
|
|
61
61
|
* + 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.
|
|
62
|
+
*
|
|
62
63
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
64
|
+
*
|
|
63
65
|
* + 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.
|
|
66
|
+
*
|
|
67
|
+
*
|
|
68
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
64
69
|
* @public
|
|
65
70
|
* @documentationMaturity preview
|
|
66
71
|
*/
|
|
67
72
|
export declare function getSenderDetails(): Promise<GetSenderDetailsResponse>;
|
|
68
73
|
/**
|
|
69
|
-
* Updates sender details
|
|
74
|
+
* Updates sender details.
|
|
75
|
+
*
|
|
76
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
77
|
+
*
|
|
78
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
70
79
|
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
80
|
+
*
|
|
81
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
73
82
|
* @param senderDetails - New sender details.
|
|
74
83
|
* @public
|
|
75
84
|
* @documentationMaturity preview
|
|
@@ -79,6 +88,8 @@ export declare function updateSenderDetails(senderDetails: SenderDetails): Promi
|
|
|
79
88
|
/**
|
|
80
89
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
81
90
|
*
|
|
91
|
+
*
|
|
92
|
+
*
|
|
82
93
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
83
94
|
* @param verificationCode - Verification code.
|
|
84
95
|
* @public
|
|
@@ -89,6 +100,8 @@ export declare function verifyEmail(verificationCode: string): Promise<void>;
|
|
|
89
100
|
/**
|
|
90
101
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
91
102
|
*
|
|
103
|
+
*
|
|
104
|
+
*
|
|
92
105
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
93
106
|
* @param fromAddress - User's provided address from which to send email marketing campaign.
|
|
94
107
|
* @public
|
|
@@ -38,8 +38,13 @@ const _verifySenderEmailResponse = {};
|
|
|
38
38
|
* The sender details include the information displayed as the email sender's name and email address.
|
|
39
39
|
*
|
|
40
40
|
* + 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.
|
|
41
|
+
*
|
|
41
42
|
* + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
|
|
43
|
+
*
|
|
42
44
|
* + 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.
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
43
48
|
* @public
|
|
44
49
|
* @documentationMaturity preview
|
|
45
50
|
*/
|
|
@@ -85,10 +90,14 @@ export function getSenderDetails() {
|
|
|
85
90
|
});
|
|
86
91
|
}
|
|
87
92
|
/**
|
|
88
|
-
* Updates sender details
|
|
93
|
+
* Updates sender details.
|
|
94
|
+
*
|
|
95
|
+
* If the `fromEmail` is changed, a verification code will be sent to the new email address.
|
|
96
|
+
*
|
|
97
|
+
* If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.
|
|
89
98
|
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
99
|
+
*
|
|
100
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
92
101
|
* @param senderDetails - New sender details.
|
|
93
102
|
* @public
|
|
94
103
|
* @documentationMaturity preview
|
|
@@ -140,6 +149,8 @@ export function updateSenderDetails(senderDetails) {
|
|
|
140
149
|
/**
|
|
141
150
|
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
142
151
|
*
|
|
152
|
+
*
|
|
153
|
+
*
|
|
143
154
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
144
155
|
* @param verificationCode - Verification code.
|
|
145
156
|
* @public
|
|
@@ -192,6 +203,8 @@ export function verifyEmail(verificationCode) {
|
|
|
192
203
|
/**
|
|
193
204
|
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
194
205
|
*
|
|
206
|
+
*
|
|
207
|
+
*
|
|
195
208
|
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
196
209
|
* @param fromAddress - User's provided address from which to send email marketing campaign.
|
|
197
210
|
* @public
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-marketing-v1-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,0CAA0C,MAAM,0CAA0C,CAAC;AAEvG,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0D5B,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC
|
|
1
|
+
{"version":3,"file":"email-marketing-v1-sender-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-sender-details.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,0CAA0C,MAAM,0CAA0C,CAAC;AAEvG,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0D5B,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAgB,gBAAgB;;;QACpC,MAAM,qBAAqB,GAAG,EAAE,CAAC;QACjC,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,wBAAwB;YACpC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC7B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,0CAA0C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,+BAA+B,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE3D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;YACxE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAgB,mBAAmB,CACvC,aAA4B;;;QAE5B,MAAM,qBAAqB,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;QACxD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,2BAA2B;YACvC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC7B,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,4BAA4B;YACxC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,0CAA0C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE3E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,eAAe;aAChB,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAgB,WAAW,CAAC,gBAAwB;;;QACxD,MAAM,qBAAqB,GAAG,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3D,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAExD,MAAM,OAAO,GACX,0CAA0C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAElE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,kBAAkB;aACnB,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAgB,wBAAwB,CAC5C,WAAmB;;;QAEnB,MAAM,qBAAqB,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;QACtD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,iCAAiC;YAC7C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QAEnD,MAAM,OAAO,GACX,0CAA0C,CAAC,wBAAwB,CACjE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,oDAAoD,SAAS,CAAC,OAAO,CAAC,EAAE,CACzE,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,aAAa;aACd,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/email-marketing",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.11",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"groupId": "com.wixpress.public-sdk-autogen"
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
|
-
"falconPackageHash": "
|
|
36
|
+
"falconPackageHash": "945e99d8cd5a27c121a1387e78e8cb08899b665d6be3c40ad279e95f"
|
|
37
37
|
}
|