@wix/email-marketing 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/build/cjs/index.d.ts +3 -0
  2. package/build/cjs/index.js +26 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/src/email-marketing-v1-account-details.http.d.ts +4 -0
  5. package/build/cjs/src/email-marketing-v1-account-details.http.js +152 -0
  6. package/build/cjs/src/email-marketing-v1-account-details.http.js.map +1 -0
  7. package/build/cjs/src/email-marketing-v1-account-details.public.d.ts +4 -0
  8. package/build/cjs/src/email-marketing-v1-account-details.public.js +13 -0
  9. package/build/cjs/src/email-marketing-v1-account-details.public.js.map +1 -0
  10. package/build/cjs/src/email-marketing-v1-account-details.types.d.ts +51 -0
  11. package/build/cjs/src/email-marketing-v1-account-details.types.js +16 -0
  12. package/build/cjs/src/email-marketing-v1-account-details.types.js.map +1 -0
  13. package/build/cjs/src/email-marketing-v1-account-details.universal.d.ts +63 -0
  14. package/build/cjs/src/email-marketing-v1-account-details.universal.js +110 -0
  15. package/build/cjs/src/email-marketing-v1-account-details.universal.js.map +1 -0
  16. package/build/cjs/src/email-marketing-v1-campaign.http.d.ts +40 -0
  17. package/build/cjs/src/email-marketing-v1-campaign.http.js +511 -0
  18. package/build/cjs/src/email-marketing-v1-campaign.http.js.map +1 -0
  19. package/build/cjs/src/email-marketing-v1-campaign.public.d.ts +13 -0
  20. package/build/cjs/src/email-marketing-v1-campaign.public.js +79 -0
  21. package/build/cjs/src/email-marketing-v1-campaign.public.js.map +1 -0
  22. package/build/cjs/src/email-marketing-v1-campaign.types.d.ts +907 -0
  23. package/build/cjs/src/email-marketing-v1-campaign.types.js +200 -0
  24. package/build/cjs/src/email-marketing-v1-campaign.types.js.map +1 -0
  25. package/build/cjs/src/email-marketing-v1-campaign.universal.d.ts +1032 -0
  26. package/build/cjs/src/email-marketing-v1-campaign.universal.js +764 -0
  27. package/build/cjs/src/email-marketing-v1-campaign.universal.js.map +1 -0
  28. package/build/cjs/src/email-marketing-v1-sender-details.http.d.ts +14 -0
  29. package/build/cjs/src/email-marketing-v1-sender-details.http.js +223 -0
  30. package/build/cjs/src/email-marketing-v1-sender-details.http.js.map +1 -0
  31. package/build/cjs/src/email-marketing-v1-sender-details.public.d.ts +7 -0
  32. package/build/cjs/src/email-marketing-v1-sender-details.public.js +29 -0
  33. package/build/cjs/src/email-marketing-v1-sender-details.public.js.map +1 -0
  34. package/build/cjs/src/email-marketing-v1-sender-details.types.d.ts +46 -0
  35. package/build/cjs/src/email-marketing-v1-sender-details.types.js +3 -0
  36. package/build/cjs/src/email-marketing-v1-sender-details.types.js.map +1 -0
  37. package/build/cjs/src/email-marketing-v1-sender-details.universal.d.ts +84 -0
  38. package/build/cjs/src/email-marketing-v1-sender-details.universal.js +259 -0
  39. package/build/cjs/src/email-marketing-v1-sender-details.universal.js.map +1 -0
  40. package/build/es/index.d.ts +3 -0
  41. package/build/es/index.js +4 -0
  42. package/build/es/index.js.map +1 -0
  43. package/build/es/src/email-marketing-v1-account-details.http.d.ts +4 -0
  44. package/build/es/src/email-marketing-v1-account-details.http.js +148 -0
  45. package/build/es/src/email-marketing-v1-account-details.http.js.map +1 -0
  46. package/build/es/src/email-marketing-v1-account-details.public.d.ts +4 -0
  47. package/build/es/src/email-marketing-v1-account-details.public.js +8 -0
  48. package/build/es/src/email-marketing-v1-account-details.public.js.map +1 -0
  49. package/build/es/src/email-marketing-v1-account-details.types.d.ts +51 -0
  50. package/build/es/src/email-marketing-v1-account-details.types.js +13 -0
  51. package/build/es/src/email-marketing-v1-account-details.types.js.map +1 -0
  52. package/build/es/src/email-marketing-v1-account-details.universal.d.ts +63 -0
  53. package/build/es/src/email-marketing-v1-account-details.universal.js +87 -0
  54. package/build/es/src/email-marketing-v1-account-details.universal.js.map +1 -0
  55. package/build/es/src/email-marketing-v1-campaign.http.d.ts +40 -0
  56. package/build/es/src/email-marketing-v1-campaign.http.js +499 -0
  57. package/build/es/src/email-marketing-v1-campaign.http.js.map +1 -0
  58. package/build/es/src/email-marketing-v1-campaign.public.d.ts +13 -0
  59. package/build/es/src/email-marketing-v1-campaign.public.js +48 -0
  60. package/build/es/src/email-marketing-v1-campaign.public.js.map +1 -0
  61. package/build/es/src/email-marketing-v1-campaign.types.d.ts +907 -0
  62. package/build/es/src/email-marketing-v1-campaign.types.js +197 -0
  63. package/build/es/src/email-marketing-v1-campaign.types.js.map +1 -0
  64. package/build/es/src/email-marketing-v1-campaign.universal.d.ts +1032 -0
  65. package/build/es/src/email-marketing-v1-campaign.universal.js +733 -0
  66. package/build/es/src/email-marketing-v1-campaign.universal.js.map +1 -0
  67. package/build/es/src/email-marketing-v1-sender-details.http.d.ts +14 -0
  68. package/build/es/src/email-marketing-v1-sender-details.http.js +216 -0
  69. package/build/es/src/email-marketing-v1-sender-details.http.js.map +1 -0
  70. package/build/es/src/email-marketing-v1-sender-details.public.d.ts +7 -0
  71. package/build/es/src/email-marketing-v1-sender-details.public.js +22 -0
  72. package/build/es/src/email-marketing-v1-sender-details.public.js.map +1 -0
  73. package/build/es/src/email-marketing-v1-sender-details.types.d.ts +46 -0
  74. package/build/es/src/email-marketing-v1-sender-details.types.js +2 -0
  75. package/build/es/src/email-marketing-v1-sender-details.types.js.map +1 -0
  76. package/build/es/src/email-marketing-v1-sender-details.universal.d.ts +84 -0
  77. package/build/es/src/email-marketing-v1-sender-details.universal.js +233 -0
  78. package/build/es/src/email-marketing-v1-sender-details.universal.js.map +1 -0
  79. package/package.json +37 -0
@@ -0,0 +1,3 @@
1
+ export * as accountDetails from './src/email-marketing-v1-account-details.public';
2
+ export * as campaigns from './src/email-marketing-v1-campaign.public';
3
+ export * as senderDetails from './src/email-marketing-v1-sender-details.public';
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
10
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
11
+ }) : function(o, v) {
12
+ o["default"] = v;
13
+ });
14
+ var __importStar = (this && this.__importStar) || function (mod) {
15
+ if (mod && mod.__esModule) return mod;
16
+ var result = {};
17
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
18
+ __setModuleDefault(result, mod);
19
+ return result;
20
+ };
21
+ Object.defineProperty(exports, "__esModule", { value: true });
22
+ exports.senderDetails = exports.campaigns = exports.accountDetails = void 0;
23
+ exports.accountDetails = __importStar(require("./src/email-marketing-v1-account-details.public"));
24
+ exports.campaigns = __importStar(require("./src/email-marketing-v1-campaign.public"));
25
+ exports.senderDetails = __importStar(require("./src/email-marketing-v1-sender-details.public"));
26
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,kGAAkF;AAClF,sFAAsE;AACtE,gGAAgF"}
@@ -0,0 +1,4 @@
1
+ import { RequestOptionsFactory } from '@wix/sdk-types';
2
+ import { GetAccountDetailsRequest, GetAccountDetailsResponse } from './email-marketing-v1-account-details.types';
3
+ /** Retrieves email marketing account details. */
4
+ export declare function get(payload: GetAccountDetailsRequest): RequestOptionsFactory<GetAccountDetailsResponse>;
@@ -0,0 +1,152 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.get = void 0;
4
+ const metro_runtime_1 = require("@wix/metro-runtime");
5
+ const ambassador_1 = require("@wix/metro-runtime/ambassador");
6
+ const metro_runtime_2 = require("@wix/metro-runtime");
7
+ const _accountDetails = { quotaPeriod: '_quotaPeriod' };
8
+ const _getAccountDetailsRequest = {};
9
+ const _getAccountDetailsResponse = { accountDetails: '_accountDetails' };
10
+ const _quotaPeriod = {
11
+ dateFrom: 'google.protobuf.Timestamp',
12
+ dateTo: 'google.protobuf.Timestamp',
13
+ };
14
+ function resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(opts) {
15
+ const domainToMappings = {
16
+ 'editor._base_domain_': [
17
+ {
18
+ srcPath: '/shoutout',
19
+ destPath: '',
20
+ },
21
+ {
22
+ srcPath: '/_api/shoutout-editor',
23
+ destPath: '/api',
24
+ },
25
+ {
26
+ srcPath: '/_api/shoutout/v1',
27
+ destPath: '/v1',
28
+ },
29
+ ],
30
+ 'blocks._base_domain_': [
31
+ {
32
+ srcPath: '/shoutout',
33
+ destPath: '',
34
+ },
35
+ {
36
+ srcPath: '/_api/shoutout-editor',
37
+ destPath: '/api',
38
+ },
39
+ {
40
+ srcPath: '/_api/shoutout/v1',
41
+ destPath: '/v1',
42
+ },
43
+ ],
44
+ 'create.editorx': [
45
+ {
46
+ srcPath: '/shoutout',
47
+ destPath: '',
48
+ },
49
+ {
50
+ srcPath: '/_api/shoutout-editor',
51
+ destPath: '/api',
52
+ },
53
+ {
54
+ srcPath: '/_api/shoutout/v1',
55
+ destPath: '/v1',
56
+ },
57
+ ],
58
+ 'shoutout._base_domain_': [
59
+ {
60
+ srcPath: '/_api/shoutout-editor',
61
+ destPath: '/api',
62
+ },
63
+ {
64
+ srcPath: '/_api/shoutout/v1',
65
+ destPath: '/v1',
66
+ },
67
+ ],
68
+ 'www._base_domain_': [
69
+ {
70
+ srcPath: '/_api/shoutout-editor',
71
+ destPath: '/api',
72
+ },
73
+ {
74
+ srcPath: '/_api/shoutout/v1',
75
+ destPath: '/v1',
76
+ },
77
+ ],
78
+ 'shoutouteditor._base_domain_': [
79
+ {
80
+ srcPath: '/_api/shoutout-editor',
81
+ destPath: '/api',
82
+ },
83
+ ],
84
+ 'api._api_base_domain_': [
85
+ {
86
+ srcPath: '/shoutout-editor',
87
+ destPath: '',
88
+ },
89
+ ],
90
+ _: [
91
+ {
92
+ srcPath: '/_api/shoutout/v1',
93
+ destPath: '/v1',
94
+ },
95
+ ],
96
+ 'api._base_domain_': [
97
+ {
98
+ srcPath: '/_api/shoutout/v1',
99
+ destPath: '/v1',
100
+ },
101
+ ],
102
+ 'manage._base_domain_': [
103
+ {
104
+ srcPath: '/_api/shoutout-editor',
105
+ destPath: '/api',
106
+ },
107
+ {
108
+ srcPath: '/_api/shoutout/v1',
109
+ destPath: '/v1',
110
+ },
111
+ ],
112
+ 'www.wixapis.com': [
113
+ {
114
+ srcPath: '/email-marketing/v1',
115
+ destPath: '/v1',
116
+ },
117
+ ],
118
+ 'bo._base_domain_': [
119
+ {
120
+ srcPath: '/shoutout-editor/v1',
121
+ destPath: '/v1',
122
+ },
123
+ ],
124
+ };
125
+ return metro_runtime_2.resolveUrl(Object.assign(opts, { domainToMappings }));
126
+ }
127
+ /** Retrieves email marketing account details. */
128
+ function get(payload) {
129
+ const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_getAccountDetailsRequest, {});
130
+ const { fromJSON: fromRes } = ambassador_1.serializer(_getAccountDetailsResponse, {
131
+ _accountDetails,
132
+ _quotaPeriod,
133
+ });
134
+ function __get({ host }) {
135
+ const serializedData = toReq(payload);
136
+ const metadata = {
137
+ method: 'GET',
138
+ url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({
139
+ protoPath: '/v1/account-details',
140
+ data: serializedData,
141
+ host,
142
+ }),
143
+ params: metro_runtime_1.toURLSearchParams(serializedData),
144
+ transformResponse: fromRes,
145
+ };
146
+ return metadata;
147
+ }
148
+ __get.fromReq = fromReq;
149
+ return __get;
150
+ }
151
+ exports.get = get;
152
+ //# sourceMappingURL=email-marketing-v1-account-details.http.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-marketing-v1-account-details.http.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-account-details.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,eAAe,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;AACxD,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC;AACzE,MAAM,YAAY,GAAG;IACnB,QAAQ,EAAE,2BAA2B;IACrC,MAAM,EAAE,2BAA2B;CACpC,CAAC;AAEF,SAAS,qDAAqD,CAC5D,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,0BAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,iDAAiD;AACjD,SAAgB,GAAG,CACjB,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,0BAA0B,EAAE;QACnE,eAAe;QACf,YAAY;KACb,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,qDAAqD,CAAC;gBACzD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iCAAiB,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;AA/BD,kBA+BC"}
@@ -0,0 +1,4 @@
1
+ import { HttpClient } from '@wix/sdk-types';
2
+ export declare function getAccountDetails(httpClient: HttpClient): () => Promise<import("./email-marketing-v1-account-details.universal").GetAccountDetailsResponse>;
3
+ export { Enum } from './email-marketing-v1-account-details.universal';
4
+ export { AccountDetails, Package, Quota, QuotaPeriod, GetAccountDetailsRequest, GetAccountDetailsResponse, } from './email-marketing-v1-account-details.universal';
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Enum = exports.getAccountDetails = void 0;
4
+ const email_marketing_v1_account_details_universal_1 = require("./email-marketing-v1-account-details.universal");
5
+ function getAccountDetails(httpClient) {
6
+ return () => email_marketing_v1_account_details_universal_1.getAccountDetails(
7
+ // @ts-ignore
8
+ { httpClient });
9
+ }
10
+ exports.getAccountDetails = getAccountDetails;
11
+ var email_marketing_v1_account_details_universal_2 = require("./email-marketing-v1-account-details.universal");
12
+ Object.defineProperty(exports, "Enum", { enumerable: true, get: function () { return email_marketing_v1_account_details_universal_2.Enum; } });
13
+ //# sourceMappingURL=email-marketing-v1-account-details.public.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-marketing-v1-account-details.public.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-account-details.public.ts"],"names":[],"mappings":";;;AACA,iHAAiH;AAEjH,SAAgB,iBAAiB,CAAC,UAAsB;IACtD,OAAO,GAAG,EAAE,CACV,gEAA0B;IACxB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,8CAMC;AAED,+GAAsE;AAA7D,oIAAA,IAAI,OAAA"}
@@ -0,0 +1,51 @@
1
+ /**
2
+ * An account can be active or in some state of suspension (warned/suspended/banned).
3
+ * If a user is in a state of suspension they must visit their email marketing account in the Wix business manager and follow the instructions.
4
+ */
5
+ export interface AccountDetails {
6
+ /** Account status. */
7
+ status?: Enum;
8
+ /** Current premium package information. */
9
+ package?: Package;
10
+ /** Quota period and usage. */
11
+ quotaPeriod?: QuotaPeriod;
12
+ }
13
+ export declare enum Enum {
14
+ UNKNOWN = "UNKNOWN",
15
+ /** Able to use email marketing normally. */
16
+ ACTIVE = "ACTIVE",
17
+ /** Must explicitly agree to terms of use to activate account. */
18
+ WARNED = "WARNED",
19
+ /** Must fill out compliance questionnaire, unable to use email marketing. */
20
+ SUSPENDED = "SUSPENDED",
21
+ /** Able to open a support ticket, unable to use email marketing. */
22
+ BANNED = "BANNED"
23
+ }
24
+ export interface Package {
25
+ /** Package ID. */
26
+ id?: string;
27
+ /** Package group. */
28
+ group?: string;
29
+ /** Allocated quota per month. */
30
+ monthlyQuotaAllocation?: Quota;
31
+ }
32
+ export interface Quota {
33
+ /** Number of allocated marketing campaigns per month (-1 means unlimited). */
34
+ campaigns?: number;
35
+ /** Number of allocated individual emails per month. */
36
+ emails?: number;
37
+ }
38
+ export interface QuotaPeriod {
39
+ /** Current quota period start date. */
40
+ dateFrom?: Date;
41
+ /** Current quota period end date - after which quota will roll over. */
42
+ dateTo?: Date;
43
+ /** Information about allocated quota already used in this period. */
44
+ quotaUsage?: Quota;
45
+ }
46
+ export interface GetAccountDetailsRequest {
47
+ }
48
+ export interface GetAccountDetailsResponse {
49
+ /** Current account details. */
50
+ accountDetails?: AccountDetails;
51
+ }
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Enum = void 0;
4
+ var Enum;
5
+ (function (Enum) {
6
+ Enum["UNKNOWN"] = "UNKNOWN";
7
+ /** Able to use email marketing normally. */
8
+ Enum["ACTIVE"] = "ACTIVE";
9
+ /** Must explicitly agree to terms of use to activate account. */
10
+ Enum["WARNED"] = "WARNED";
11
+ /** Must fill out compliance questionnaire, unable to use email marketing. */
12
+ Enum["SUSPENDED"] = "SUSPENDED";
13
+ /** Able to open a support ticket, unable to use email marketing. */
14
+ Enum["BANNED"] = "BANNED";
15
+ })(Enum = exports.Enum || (exports.Enum = {}));
16
+ //# sourceMappingURL=email-marketing-v1-account-details.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-marketing-v1-account-details.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-account-details.types.ts"],"names":[],"mappings":";;;AAaA,IAAY,IAUX;AAVD,WAAY,IAAI;IACd,2BAAmB,CAAA;IACnB,4CAA4C;IAC5C,yBAAiB,CAAA;IACjB,iEAAiE;IACjE,yBAAiB,CAAA;IACjB,6EAA6E;IAC7E,+BAAuB,CAAA;IACvB,oEAAoE;IACpE,yBAAiB,CAAA;AACnB,CAAC,EAVW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAUf"}
@@ -0,0 +1,63 @@
1
+ export declare const __debug: {
2
+ verboseLogging: {
3
+ on: () => boolean;
4
+ off: () => boolean;
5
+ };
6
+ };
7
+ /**
8
+ * An account can be active or in some state of suspension (warned/suspended/banned).
9
+ * If a user is in a state of suspension they must visit their email marketing account in the Wix business manager and follow the instructions.
10
+ */
11
+ export interface AccountDetails {
12
+ /** Account status. */
13
+ status?: Enum;
14
+ /** Current premium package information. */
15
+ package?: Package;
16
+ /** Quota period and usage. */
17
+ quotaPeriod?: QuotaPeriod;
18
+ }
19
+ export declare enum Enum {
20
+ UNKNOWN = "UNKNOWN",
21
+ /** Able to use email marketing normally. */
22
+ ACTIVE = "ACTIVE",
23
+ /** Must explicitly agree to terms of use to activate account. */
24
+ WARNED = "WARNED",
25
+ /** Must fill out compliance questionnaire, unable to use email marketing. */
26
+ SUSPENDED = "SUSPENDED",
27
+ /** Able to open a support ticket, unable to use email marketing. */
28
+ BANNED = "BANNED"
29
+ }
30
+ export interface Package {
31
+ /** Package ID. */
32
+ _id?: string;
33
+ /** Package group. */
34
+ group?: string;
35
+ /** Allocated quota per month. */
36
+ monthlyQuotaAllocation?: Quota;
37
+ }
38
+ export interface Quota {
39
+ /** Number of allocated marketing campaigns per month (-1 means unlimited). */
40
+ campaigns?: number;
41
+ /** Number of allocated individual emails per month. */
42
+ emails?: number;
43
+ }
44
+ export interface QuotaPeriod {
45
+ /** Current quota period start date. */
46
+ dateFrom?: Date;
47
+ /** Current quota period end date - after which quota will roll over. */
48
+ dateTo?: Date;
49
+ /** Information about allocated quota already used in this period. */
50
+ quotaUsage?: Quota;
51
+ }
52
+ export interface GetAccountDetailsRequest {
53
+ }
54
+ export interface GetAccountDetailsResponse {
55
+ /** Current account details. */
56
+ accountDetails?: AccountDetails;
57
+ }
58
+ /**
59
+ * Retrieves email marketing account details.
60
+ * @public
61
+ * @documentationMaturity preview
62
+ */
63
+ export declare function getAccountDetails(): Promise<GetAccountDetailsResponse>;
@@ -0,0 +1,110 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
10
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
11
+ }) : function(o, v) {
12
+ o["default"] = v;
13
+ });
14
+ var __importStar = (this && this.__importStar) || function (mod) {
15
+ if (mod && mod.__esModule) return mod;
16
+ var result = {};
17
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
18
+ __setModuleDefault(result, mod);
19
+ return result;
20
+ };
21
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
22
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
23
+ return new (P || (P = Promise))(function (resolve, reject) {
24
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
25
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
26
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
27
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
28
+ });
29
+ };
30
+ Object.defineProperty(exports, "__esModule", { value: true });
31
+ exports.getAccountDetails = exports.Enum = exports.__debug = void 0;
32
+ const velo_1 = require("@wix/metro-runtime/velo");
33
+ const ambassadorWixEmailMarketingV1AccountDetails = __importStar(require("./email-marketing-v1-account-details.http"));
34
+ let __verbose = false;
35
+ function __log(...args) {
36
+ __verbose && console.log(...args);
37
+ }
38
+ function __inspect(obj) {
39
+ return obj;
40
+ }
41
+ exports.__debug = {
42
+ verboseLogging: {
43
+ on: () => (__verbose = true),
44
+ off: () => (__verbose = false),
45
+ },
46
+ };
47
+ const _toVeloEntity = '$';
48
+ const _fromVeloEntity = '$';
49
+ var Enum;
50
+ (function (Enum) {
51
+ Enum["UNKNOWN"] = "UNKNOWN";
52
+ /** Able to use email marketing normally. */
53
+ Enum["ACTIVE"] = "ACTIVE";
54
+ /** Must explicitly agree to terms of use to activate account. */
55
+ Enum["WARNED"] = "WARNED";
56
+ /** Must fill out compliance questionnaire, unable to use email marketing. */
57
+ Enum["SUSPENDED"] = "SUSPENDED";
58
+ /** Able to open a support ticket, unable to use email marketing. */
59
+ Enum["BANNED"] = "BANNED";
60
+ })(Enum = exports.Enum || (exports.Enum = {}));
61
+ const _getAccountDetailsRequest = {};
62
+ const _getAccountDetailsResponse = {};
63
+ /**
64
+ * Retrieves email marketing account details.
65
+ * @public
66
+ * @documentationMaturity preview
67
+ */
68
+ function getAccountDetails() {
69
+ var _a, _b, _c;
70
+ return __awaiter(this, arguments, void 0, function* () {
71
+ const requestTransformation = {};
72
+ const responseTransformation = '$';
73
+ // @ts-ignore
74
+ const { httpClient, sideEffects } = arguments[0];
75
+ const { toAmbassadorRequest } = velo_1.serializer({
76
+ rootSchema: _getAccountDetailsRequest,
77
+ depSchemas: {},
78
+ fqdnTransformation: {
79
+ paths: [],
80
+ transformation: _fromVeloEntity,
81
+ },
82
+ customTransformation: requestTransformation,
83
+ });
84
+ const { fromJSON } = velo_1.serializer({
85
+ rootSchema: _getAccountDetailsResponse,
86
+ depSchemas: {},
87
+ fqdnTransformation: {
88
+ paths: [...['accountDetails']],
89
+ transformation: _toVeloEntity,
90
+ },
91
+ customTransformation: responseTransformation,
92
+ });
93
+ const payload = toAmbassadorRequest([]);
94
+ const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);
95
+ __log(`"Get" sending request with: ${__inspect(reqOpts)}`);
96
+ (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
97
+ try {
98
+ const result = yield httpClient.request(reqOpts);
99
+ (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
100
+ return fromJSON(result.data);
101
+ }
102
+ catch (err) {
103
+ const transformedError = velo_1.transformError(err, requestTransformation, []);
104
+ (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
105
+ throw transformedError;
106
+ }
107
+ });
108
+ }
109
+ exports.getAccountDetails = getAccountDetails;
110
+ //# sourceMappingURL=email-marketing-v1-account-details.universal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-marketing-v1-account-details.universal.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-account-details.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,uHAAyG;AAEzG,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;AAe5B,IAAY,IAUX;AAVD,WAAY,IAAI;IACd,2BAAmB,CAAA;IACnB,4CAA4C;IAC5C,yBAAiB,CAAA;IACjB,iEAAiE;IACjE,yBAAiB,CAAA;IACjB,6EAA6E;IAC7E,+BAAuB,CAAA;IACvB,oEAAoE;IACpE,yBAAiB,CAAA;AACnB,CAAC,EAVW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAUf;AAkCD,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAEtC;;;;GAIG;AACH,SAAsB,iBAAiB;;;QACrC,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,iBAAU,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,iBAAU,CAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;gBAC9B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,2CAA2C,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEzE,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,qBAAc,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;AAhDD,8CAgDC"}
@@ -0,0 +1,40 @@
1
+ import { RequestOptionsFactory } from '@wix/sdk-types';
2
+ import { DeleteCampaignRequest, DeleteCampaignResponse, GetCampaignRequest, GetCampaignResponse, ListCampaignsRequest, ListCampaignsResponse, ListRecipientsRequest, ListRecipientsResponse, ListStatisticsRequest, ListStatisticsResponse, PauseSchedulingRequest, PauseSchedulingResponse, PublishCampaignRequest, PublishCampaignResponse, ReuseCampaignRequest, ReuseCampaignResponse, SendTestRequest, SendTestResponse } from './email-marketing-v1-campaign.types';
3
+ /**
4
+ * Retrieves a list of statistics for up to 100 selected campaigns.
5
+ *
6
+ * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
7
+ * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
8
+ *
9
+ * Use [List Campaigns](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-campaigns) to retrieve additional information for your campaigns.
10
+ * Use [List Recipients](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-recipients) to retrieve a list of recipients and their activities related to a selected campaign.
11
+ */
12
+ export declare function listStatistics(payload: ListStatisticsRequest): RequestOptionsFactory<ListStatisticsResponse>;
13
+ /**
14
+ * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
15
+ *
16
+ * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
17
+ *
18
+ * Use [List Statistics](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-statistics) to retrieve a list of activity for selected campaigns.
19
+ * Use [List Campaigns](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-campaigns) to retrieve additional information for your campaigns.
20
+ *
21
+ * > __Note__: If no `activity` is included, this endpoint returns an error.
22
+ */
23
+ export declare function listRecipients(payload: ListRecipientsRequest): RequestOptionsFactory<ListRecipientsResponse>;
24
+ /** Retrieves information about an email campaign. */
25
+ export declare function get(payload: GetCampaignRequest): RequestOptionsFactory<GetCampaignResponse>;
26
+ /** Returns a list of email campaigns. These are always ordered by `date_updated` in descending order. */
27
+ export declare function list(payload: ListCampaignsRequest): RequestOptionsFactory<ListCampaignsResponse>;
28
+ /**
29
+ * Publishes/sends a specified campaign.
30
+ * If `email_distribution_options` are not supplied, the campaign is only published as a landing page.
31
+ */
32
+ export declare function publish(payload: PublishCampaignRequest): RequestOptionsFactory<PublishCampaignResponse>;
33
+ /** Sends a test email for preview purposes. It is heavily throttled - do not use this for regular campaign sending. */
34
+ export declare function sendTest(payload: SendTestRequest): RequestOptionsFactory<SendTestResponse>;
35
+ /** Pauses a scheduled campaign. Learn more about [market campaign scheduling](https://support.wix.com/en/article/managing-your-scheduled-email-marketing-campaign). */
36
+ export declare function pauseScheduling(payload: PauseSchedulingRequest): RequestOptionsFactory<PauseSchedulingResponse>;
37
+ /** Deletes a campaign (cannot be undone). */
38
+ export declare function _delete(payload: DeleteCampaignRequest): RequestOptionsFactory<DeleteCampaignResponse>;
39
+ /** Creates a (draft) copy of an existing campaign. */
40
+ export declare function reuse(payload: ReuseCampaignRequest): RequestOptionsFactory<ReuseCampaignResponse>;