@wix/auto_sdk_email-marketing_campaigns 1.0.17 → 1.0.18

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 (134) hide show
  1. package/build/{cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts → email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.mts} +472 -544
  2. package/build/{internal/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts → email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.ts} +472 -544
  3. package/build/index.d.mts +186 -0
  4. package/build/index.d.ts +186 -0
  5. package/build/index.js +1206 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1152 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/email-marketing-v1-campaign-campaigns.types.d.ts → email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.mts} +472 -544
  10. package/build/{es/src/email-marketing-v1-campaign-campaigns.types.d.ts → internal/email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.ts} +472 -544
  11. package/build/internal/index.d.mts +186 -0
  12. package/build/internal/index.d.ts +186 -0
  13. package/build/internal/index.js +1206 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1152 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +510 -0
  18. package/build/internal/meta.d.ts +510 -0
  19. package/build/internal/meta.js +713 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +675 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +510 -0
  24. package/build/meta.d.ts +510 -0
  25. package/build/meta.js +713 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +675 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
  40. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js +0 -77
  41. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
  42. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
  43. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js +0 -559
  44. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
  45. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
  46. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +0 -294
  47. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
  48. package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
  49. package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js +0 -171
  50. package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
  51. package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js +0 -148
  52. package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
  53. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
  54. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +0 -805
  55. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
  67. package/build/es/src/email-marketing-v1-campaign-campaigns.context.js +0 -64
  68. package/build/es/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
  69. package/build/es/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
  70. package/build/es/src/email-marketing-v1-campaign-campaigns.http.js +0 -542
  71. package/build/es/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
  72. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
  73. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js +0 -254
  74. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
  75. package/build/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
  76. package/build/es/src/email-marketing-v1-campaign-campaigns.public.js +0 -144
  77. package/build/es/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
  78. package/build/es/src/email-marketing-v1-campaign-campaigns.types.js +0 -145
  79. package/build/es/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
  80. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
  81. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js +0 -765
  82. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
  93. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js +0 -77
  94. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
  95. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
  96. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js +0 -559
  97. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
  98. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
  99. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +0 -294
  100. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
  101. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
  102. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js +0 -171
  103. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
  104. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js +0 -148
  105. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
  106. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
  107. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +0 -805
  108. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
  119. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js +0 -64
  120. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
  121. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
  122. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js +0 -542
  123. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
  124. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
  125. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js +0 -254
  126. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
  127. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
  128. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js +0 -144
  129. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
  130. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js +0 -145
  131. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
  132. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
  133. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js +0 -765
  134. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
@@ -1,805 +0,0 @@
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.validateHtmlLinks = exports.validateLink = exports.identifySenderAddress = exports.getAudience = exports.reuseCampaign = exports.deleteCampaign = exports.reschedule = exports.pauseScheduling = exports.sendTest = exports.publishCampaign = exports.listCampaigns = exports.getCampaign = exports.listRecipients = exports.listStatistics = exports.WebhookIdentityType = exports.ActivityType = exports.RecipientsActivityEnum = exports.CampaignTypeEnum = exports.CampaignSendingStateEnum = exports.RejectionReasonEnum = exports.Enum = exports.CampaignVisibilityStatusEnum = exports.CampaignStatusEnum = exports.CampaignEditorTypeEnum = 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 ambassadorWixEmailMarketingV1Campaign = __importStar(require("./email-marketing-v1-campaign-campaigns.http.js"));
30
- var CampaignEditorTypeEnum;
31
- (function (CampaignEditorTypeEnum) {
32
- /** Unknown editor. This value isn't used. */
33
- CampaignEditorTypeEnum["UNKNOWN"] = "UNKNOWN";
34
- /** Classic web editor. */
35
- CampaignEditorTypeEnum["WEB"] = "WEB";
36
- /** Classic mobile editor. */
37
- CampaignEditorTypeEnum["MOBILE"] = "MOBILE";
38
- /** Chat (AI) based web editor. */
39
- CampaignEditorTypeEnum["MJML"] = "MJML";
40
- })(CampaignEditorTypeEnum || (exports.CampaignEditorTypeEnum = CampaignEditorTypeEnum = {}));
41
- var CampaignStatusEnum;
42
- (function (CampaignStatusEnum) {
43
- /** Unknown campaign. This value isn't used. */
44
- CampaignStatusEnum["UNKNOWN"] = "UNKNOWN";
45
- /** Campaign is active. */
46
- CampaignStatusEnum["ACTIVE"] = "ACTIVE";
47
- /** Campaign is archived. */
48
- CampaignStatusEnum["ARCHIVED"] = "ARCHIVED";
49
- /** Campaign is deleted. */
50
- CampaignStatusEnum["DELETED"] = "DELETED";
51
- })(CampaignStatusEnum || (exports.CampaignStatusEnum = CampaignStatusEnum = {}));
52
- var CampaignVisibilityStatusEnum;
53
- (function (CampaignVisibilityStatusEnum) {
54
- /** Unknown status. This value isn't used. */
55
- CampaignVisibilityStatusEnum["UNKNOWN"] = "UNKNOWN";
56
- /** Campaign isn't published yet. */
57
- CampaignVisibilityStatusEnum["DRAFT"] = "DRAFT";
58
- /** Campaign is published. */
59
- CampaignVisibilityStatusEnum["PUBLISHED"] = "PUBLISHED";
60
- /** Campaign is a template. */
61
- CampaignVisibilityStatusEnum["TEMPLATE"] = "TEMPLATE";
62
- })(CampaignVisibilityStatusEnum || (exports.CampaignVisibilityStatusEnum = CampaignVisibilityStatusEnum = {}));
63
- var Enum;
64
- (function (Enum) {
65
- /** Unknown distribution status. */
66
- Enum["UNKNOWN"] = "UNKNOWN";
67
- /** Campaign isn't distributed to recipients yet. */
68
- Enum["NOT_STARTED"] = "NOT_STARTED";
69
- /** Campaign is scheduled for distribution. */
70
- Enum["SCHEDULED"] = "SCHEDULED";
71
- /** Campaign is in screening for malicious content. */
72
- Enum["IN_DETECTION"] = "IN_DETECTION";
73
- /** Campaign is in review by the site moderators. */
74
- Enum["IN_MODERATION"] = "IN_MODERATION";
75
- /** Several recipients are selected for campaign testing, and campaign is sent out to them. */
76
- Enum["SAMPLING"] = "SAMPLING";
77
- /** Campaign is being sent out to all recipients. */
78
- Enum["SENDING"] = "SENDING";
79
- /** Campaign is rejected. */
80
- Enum["REJECTED"] = "REJECTED";
81
- /** Campaign is terminated after a failed sampling test. */
82
- Enum["TERMINATED"] = "TERMINATED";
83
- /** Campaign is fully distributed to all recipients. */
84
- Enum["DISTRIBUTED"] = "DISTRIBUTED";
85
- /** Scheduled campaign is paused. */
86
- Enum["PAUSED"] = "PAUSED";
87
- })(Enum || (exports.Enum = Enum = {}));
88
- var RejectionReasonEnum;
89
- (function (RejectionReasonEnum) {
90
- RejectionReasonEnum["UNKNOWN"] = "UNKNOWN";
91
- RejectionReasonEnum["LOW_ENGAGEMENT"] = "LOW_ENGAGEMENT";
92
- RejectionReasonEnum["SENDER_DETAILS"] = "SENDER_DETAILS";
93
- RejectionReasonEnum["SPAM_TRAPS"] = "SPAM_TRAPS";
94
- RejectionReasonEnum["OTHER"] = "OTHER";
95
- RejectionReasonEnum["ADULT_SEXUAL_CONTENT"] = "ADULT_SEXUAL_CONTENT";
96
- RejectionReasonEnum["AFFILIATE_MARKETING"] = "AFFILIATE_MARKETING";
97
- RejectionReasonEnum["BETTING_OR_GAMBLING"] = "BETTING_OR_GAMBLING";
98
- RejectionReasonEnum["CREDIT_REPAIR_OR_DEBT_RELIEF"] = "CREDIT_REPAIR_OR_DEBT_RELIEF";
99
- RejectionReasonEnum["GET_RICH_QUICK_SCHEME"] = "GET_RICH_QUICK_SCHEME";
100
- RejectionReasonEnum["ILLEGAL_SUBSTANCES_OR_WEAPONS"] = "ILLEGAL_SUBSTANCES_OR_WEAPONS";
101
- RejectionReasonEnum["MISLEADING_SUBJECT_LINE"] = "MISLEADING_SUBJECT_LINE";
102
- RejectionReasonEnum["TRADING_OR_CRYPTOCURRENCIES"] = "TRADING_OR_CRYPTOCURRENCIES";
103
- RejectionReasonEnum["UNSOLICITED_CONTENT"] = "UNSOLICITED_CONTENT";
104
- })(RejectionReasonEnum || (exports.RejectionReasonEnum = RejectionReasonEnum = {}));
105
- var CampaignSendingStateEnum;
106
- (function (CampaignSendingStateEnum) {
107
- /** Campaign not yet published. */
108
- CampaignSendingStateEnum["DRAFT"] = "DRAFT";
109
- /** Campaign is being reviewed. */
110
- CampaignSendingStateEnum["REVIEW"] = "REVIEW";
111
- /** Campaign was rejected. */
112
- CampaignSendingStateEnum["REJECTED"] = "REJECTED";
113
- /** Campaign is scheduled. */
114
- CampaignSendingStateEnum["SCHEDULED"] = "SCHEDULED";
115
- /** Scheduled campaign was paused. */
116
- CampaignSendingStateEnum["PAUSED"] = "PAUSED";
117
- /** Campaign is published. */
118
- CampaignSendingStateEnum["PUBLISHED"] = "PUBLISHED";
119
- /** Campaign is being send. */
120
- CampaignSendingStateEnum["SENDING"] = "SENDING";
121
- /**
122
- * Campaign was partially sent.
123
- * Happens when too many recipients bounce.
124
- */
125
- CampaignSendingStateEnum["PARTIALLY_SENT"] = "PARTIALLY_SENT";
126
- /** Campaign was sent. */
127
- CampaignSendingStateEnum["SENT"] = "SENT";
128
- })(CampaignSendingStateEnum || (exports.CampaignSendingStateEnum = CampaignSendingStateEnum = {}));
129
- var CampaignTypeEnum;
130
- (function (CampaignTypeEnum) {
131
- CampaignTypeEnum["UNKNOWN"] = "UNKNOWN";
132
- /** Email marketing campaign. */
133
- CampaignTypeEnum["EMAIL_MARKETING"] = "EMAIL_MARKETING";
134
- /** Mobile place invitation email. */
135
- CampaignTypeEnum["INVITATION"] = "INVITATION";
136
- /** Automation campaign. */
137
- CampaignTypeEnum["AUTOMATION"] = "AUTOMATION";
138
- /** Triggered email. */
139
- CampaignTypeEnum["TRIGGERED"] = "TRIGGERED";
140
- })(CampaignTypeEnum || (exports.CampaignTypeEnum = CampaignTypeEnum = {}));
141
- var RecipientsActivityEnum;
142
- (function (RecipientsActivityEnum) {
143
- RecipientsActivityEnum["UNKNOWN"] = "UNKNOWN";
144
- RecipientsActivityEnum["DELIVERED"] = "DELIVERED";
145
- RecipientsActivityEnum["OPENED"] = "OPENED";
146
- RecipientsActivityEnum["CLICKED"] = "CLICKED";
147
- RecipientsActivityEnum["BOUNCED"] = "BOUNCED";
148
- RecipientsActivityEnum["NOT_SENT"] = "NOT_SENT";
149
- RecipientsActivityEnum["SENT"] = "SENT";
150
- RecipientsActivityEnum["NOT_OPENED"] = "NOT_OPENED";
151
- })(RecipientsActivityEnum || (exports.RecipientsActivityEnum = RecipientsActivityEnum = {}));
152
- /** The type of email activity that triggered the webhook. */
153
- var ActivityType;
154
- (function (ActivityType) {
155
- /** Triggered when an email is delivered to the recipient. */
156
- ActivityType["DELIVERY"] = "DELIVERY";
157
- /** Triggered when the recipient clicks on a URL inside of the email. */
158
- ActivityType["CLICK"] = "CLICK";
159
- /** Triggered when the email is opened by the recipient. */
160
- ActivityType["OPEN"] = "OPEN";
161
- /** Triggered when the email is bounced softly. */
162
- ActivityType["SOFT_BOUNCE"] = "SOFT_BOUNCE";
163
- /** Triggered when the email bounces. */
164
- ActivityType["HARD_BOUNCED"] = "HARD_BOUNCED";
165
- })(ActivityType || (exports.ActivityType = ActivityType = {}));
166
- var WebhookIdentityType;
167
- (function (WebhookIdentityType) {
168
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
169
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
170
- WebhookIdentityType["MEMBER"] = "MEMBER";
171
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
172
- WebhookIdentityType["APP"] = "APP";
173
- })(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
174
- /**
175
- * Retrieves a list of statistics for up to 100 selected campaigns.
176
- *
177
- * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
178
- * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
179
- *
180
- * Call List Campaigns to retrieve additional information for a site's campaigns.
181
- * Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
182
- * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
183
- * @public
184
- * @requiredField campaignIds
185
- * @permissionId Shoutout.Read
186
- * @permissionScope Manage Stores
187
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
188
- * @permissionScope Access Verticals by Automations
189
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
190
- * @permissionScope Set Up Automations
191
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
192
- * @permissionScope Read Email Marketing
193
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
194
- * @permissionScope Manage Email Marketing
195
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
196
- * @applicableIdentity APP
197
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
198
- */
199
- async function listStatistics(campaignIds) {
200
- // @ts-ignore
201
- const { httpClient, sideEffects } = arguments[1];
202
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
203
- campaignIds: campaignIds,
204
- });
205
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.listStatistics(payload);
206
- sideEffects?.onSiteCall?.();
207
- try {
208
- const result = await httpClient.request(reqOpts);
209
- sideEffects?.onSuccess?.(result);
210
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
211
- }
212
- catch (err) {
213
- const transformedError = (0, transform_error_1.transformError)(err, {
214
- spreadPathsToArguments: {},
215
- explicitPathsToArguments: { campaignIds: '$[0]' },
216
- singleArgumentUnchanged: false,
217
- }, ['campaignIds']);
218
- sideEffects?.onError?.(err);
219
- throw transformedError;
220
- }
221
- }
222
- exports.listStatistics = listStatistics;
223
- /**
224
- * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
225
- *
226
- * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
227
- *
228
- * Call List Statistics to retrieve a list of activity for selected campaigns.
229
- * Call List Campaigns to retrieve additional information for your campaigns.
230
- *
231
- * If no `activity` is included, this method returns an error.
232
- * @param campaignId - Campaign ID.
233
- * @param activity - Email activity to filter.
234
- * @public
235
- * @requiredField activity
236
- * @requiredField campaignId
237
- * @param options - Options to use when getting the list of recipients.
238
- * @permissionId Shoutout.Read
239
- * @permissionScope Manage Stores
240
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
241
- * @permissionScope Access Verticals by Automations
242
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
243
- * @permissionScope Set Up Automations
244
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
245
- * @permissionScope Read Email Marketing
246
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
247
- * @permissionScope Manage Email Marketing
248
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
249
- * @applicableIdentity APP
250
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
251
- */
252
- async function listRecipients(campaignId, activity, options) {
253
- // @ts-ignore
254
- const { httpClient, sideEffects } = arguments[3];
255
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
256
- campaignId: campaignId,
257
- activity: activity,
258
- paging: options?.paging,
259
- });
260
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.listRecipients(payload);
261
- sideEffects?.onSiteCall?.();
262
- try {
263
- const result = await httpClient.request(reqOpts);
264
- sideEffects?.onSuccess?.(result);
265
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
266
- }
267
- catch (err) {
268
- const transformedError = (0, transform_error_1.transformError)(err, {
269
- spreadPathsToArguments: {},
270
- explicitPathsToArguments: {
271
- campaignId: '$[0]',
272
- activity: '$[1]',
273
- paging: '$[2].paging',
274
- },
275
- singleArgumentUnchanged: false,
276
- }, ['campaignId', 'activity', 'options']);
277
- sideEffects?.onError?.(err);
278
- throw transformedError;
279
- }
280
- }
281
- exports.listRecipients = listRecipients;
282
- /**
283
- * Retrieves information about an email campaign.
284
- * @param campaignId - Campaign ID.
285
- * @public
286
- * @requiredField campaignId
287
- * @param options - Options to use when getting a campaign.
288
- * @permissionId Shoutout.Manage
289
- * @permissionScope Manage Stores
290
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
291
- * @permissionScope Access Verticals by Automations
292
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
293
- * @permissionScope Set Up Automations
294
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
295
- * @permissionScope Manage Email Marketing
296
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
297
- * @applicableIdentity APP
298
- * @returns Campaign information.
299
- * @fqn wix.emailmarketing.api.v1.CampaignService.Get
300
- */
301
- async function getCampaign(campaignId, options) {
302
- // @ts-ignore
303
- const { httpClient, sideEffects } = arguments[2];
304
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
305
- campaignId: campaignId,
306
- optionIncludeStatistics: options?.optionIncludeStatistics,
307
- });
308
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.get(payload);
309
- sideEffects?.onSiteCall?.();
310
- try {
311
- const result = await httpClient.request(reqOpts);
312
- sideEffects?.onSuccess?.(result);
313
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data)?.campaign;
314
- }
315
- catch (err) {
316
- const transformedError = (0, transform_error_1.transformError)(err, {
317
- spreadPathsToArguments: {},
318
- explicitPathsToArguments: {
319
- campaignId: '$[0]',
320
- optionIncludeStatistics: '$[1].optionIncludeStatistics',
321
- },
322
- singleArgumentUnchanged: false,
323
- }, ['campaignId', 'options']);
324
- sideEffects?.onError?.(err);
325
- throw transformedError;
326
- }
327
- }
328
- exports.getCampaign = getCampaign;
329
- /**
330
- * Retrieves a list of email campaigns.
331
- *
332
- * Default sorts by `dateUpdated` in `DESC` order.
333
- * @public
334
- * @param options - Options to use when getting the list of campaigns.
335
- * @permissionId Shoutout.Read
336
- * @permissionScope Manage Stores
337
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
338
- * @permissionScope Access Verticals by Automations
339
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
340
- * @permissionScope Set Up Automations
341
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
342
- * @permissionScope Read Email Marketing
343
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
344
- * @permissionScope Manage Email Marketing
345
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
346
- * @applicableIdentity APP
347
- * @fqn wix.emailmarketing.api.v1.CampaignService.List
348
- */
349
- async function listCampaigns(options) {
350
- // @ts-ignore
351
- const { httpClient, sideEffects } = arguments[1];
352
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
353
- paging: options?.paging,
354
- optionIncludeStatistics: options?.optionIncludeStatistics,
355
- statuses: options?.statuses,
356
- visibilityStatuses: options?.visibilityStatuses,
357
- });
358
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.list(payload);
359
- sideEffects?.onSiteCall?.();
360
- try {
361
- const result = await httpClient.request(reqOpts);
362
- sideEffects?.onSuccess?.(result);
363
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
364
- }
365
- catch (err) {
366
- const transformedError = (0, transform_error_1.transformError)(err, {
367
- spreadPathsToArguments: {},
368
- explicitPathsToArguments: {
369
- paging: '$[0].paging',
370
- optionIncludeStatistics: '$[0].optionIncludeStatistics',
371
- statuses: '$[0].statuses',
372
- visibilityStatuses: '$[0].visibilityStatuses',
373
- },
374
- singleArgumentUnchanged: false,
375
- }, ['options']);
376
- sideEffects?.onError?.(err);
377
- throw transformedError;
378
- }
379
- }
380
- exports.listCampaigns = listCampaigns;
381
- /**
382
- * Publishes and sends a specified campaign.
383
- *
384
- * If the `email_distribution_options` object isn't passed in the request, the campaign is only published as a landing page.
385
- * @param campaignId - Campaign ID
386
- * @public
387
- * @requiredField campaignId
388
- * @param options - Options to use when publishing a campaign.
389
- * @permissionId Shoutout.Manage
390
- * @permissionScope Manage Stores
391
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
392
- * @permissionScope Access Verticals by Automations
393
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
394
- * @permissionScope Set Up Automations
395
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
396
- * @permissionScope Manage Email Marketing
397
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
398
- * @applicableIdentity APP
399
- * @fqn wix.emailmarketing.api.v1.CampaignService.Publish
400
- */
401
- async function publishCampaign(campaignId, options) {
402
- // @ts-ignore
403
- const { httpClient, sideEffects } = arguments[2];
404
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
405
- campaignId: campaignId,
406
- emailDistributionOptions: options?.emailDistributionOptions,
407
- });
408
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.publish(payload);
409
- sideEffects?.onSiteCall?.();
410
- try {
411
- const result = await httpClient.request(reqOpts);
412
- sideEffects?.onSuccess?.(result);
413
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
414
- }
415
- catch (err) {
416
- const transformedError = (0, transform_error_1.transformError)(err, {
417
- spreadPathsToArguments: {},
418
- explicitPathsToArguments: {
419
- campaignId: '$[0]',
420
- emailDistributionOptions: '$[1].emailDistributionOptions',
421
- },
422
- singleArgumentUnchanged: false,
423
- }, ['campaignId', 'options']);
424
- sideEffects?.onError?.(err);
425
- throw transformedError;
426
- }
427
- }
428
- exports.publishCampaign = publishCampaign;
429
- /**
430
- * Sends a test email. Call this method to preview your email campaign.
431
- *
432
- * We strongly recommend calling this method only a few times in a row, as there is a rate limit to prevent abuse of the Send Test method.
433
- * @param campaignId - Campaign ID.
434
- * @public
435
- * @requiredField campaignId
436
- * @requiredField options.toEmailAddress
437
- * @param options - Options for sending a test email.
438
- * @permissionId Shoutout.Manage
439
- * @permissionScope Manage Stores
440
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
441
- * @permissionScope Access Verticals by Automations
442
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
443
- * @permissionScope Set Up Automations
444
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
445
- * @permissionScope Manage Email Marketing
446
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
447
- * @applicableIdentity APP
448
- * @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
449
- */
450
- async function sendTest(campaignId, options) {
451
- // @ts-ignore
452
- const { httpClient, sideEffects } = arguments[2];
453
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
454
- campaignId: campaignId,
455
- emailSubject: options?.emailSubject,
456
- toEmailAddress: options?.toEmailAddress,
457
- });
458
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.sendTest(payload);
459
- sideEffects?.onSiteCall?.();
460
- try {
461
- const result = await httpClient.request(reqOpts);
462
- sideEffects?.onSuccess?.(result);
463
- }
464
- catch (err) {
465
- const transformedError = (0, transform_error_1.transformError)(err, {
466
- spreadPathsToArguments: {},
467
- explicitPathsToArguments: {
468
- campaignId: '$[0]',
469
- emailSubject: '$[1].emailSubject',
470
- toEmailAddress: '$[1].toEmailAddress',
471
- },
472
- singleArgumentUnchanged: false,
473
- }, ['campaignId', 'options']);
474
- sideEffects?.onError?.(err);
475
- throw transformedError;
476
- }
477
- }
478
- exports.sendTest = sendTest;
479
- /**
480
- * Pauses a scheduled campaign.
481
- * @param campaignId - Campaign ID.
482
- * @public
483
- * @requiredField campaignId
484
- * @permissionId Shoutout.Manage
485
- * @permissionScope Manage Stores
486
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
487
- * @permissionScope Access Verticals by Automations
488
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
489
- * @permissionScope Set Up Automations
490
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
491
- * @permissionScope Manage Email Marketing
492
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
493
- * @applicableIdentity APP
494
- * @fqn wix.emailmarketing.api.v1.CampaignService.PauseScheduling
495
- */
496
- async function pauseScheduling(campaignId) {
497
- // @ts-ignore
498
- const { httpClient, sideEffects } = arguments[1];
499
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
500
- campaignId: campaignId,
501
- });
502
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.pauseScheduling(payload);
503
- sideEffects?.onSiteCall?.();
504
- try {
505
- const result = await httpClient.request(reqOpts);
506
- sideEffects?.onSuccess?.(result);
507
- }
508
- catch (err) {
509
- const transformedError = (0, transform_error_1.transformError)(err, {
510
- spreadPathsToArguments: {},
511
- explicitPathsToArguments: { campaignId: '$[0]' },
512
- singleArgumentUnchanged: false,
513
- }, ['campaignId']);
514
- sideEffects?.onError?.(err);
515
- throw transformedError;
516
- }
517
- }
518
- exports.pauseScheduling = pauseScheduling;
519
- /**
520
- * Changes the sending time for an already scheduled campaign.
521
- * @param campaignId - ID of the campaign to reschedule.
522
- * @param sendAt - New time for sending out the campaign.
523
- * @public
524
- * @requiredField campaignId
525
- * @requiredField sendAt
526
- * @permissionId Shoutout.Manage
527
- * @permissionScope Manage Stores
528
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
529
- * @permissionScope Access Verticals by Automations
530
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
531
- * @permissionScope Set Up Automations
532
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
533
- * @permissionScope Manage Email Marketing
534
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
535
- * @applicableIdentity APP
536
- * @fqn wix.emailmarketing.api.v1.CampaignService.Reschedule
537
- */
538
- async function reschedule(campaignId, sendAt) {
539
- // @ts-ignore
540
- const { httpClient, sideEffects } = arguments[2];
541
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
542
- campaignId: campaignId,
543
- sendAt: sendAt,
544
- });
545
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.reschedule(payload);
546
- sideEffects?.onSiteCall?.();
547
- try {
548
- const result = await httpClient.request(reqOpts);
549
- sideEffects?.onSuccess?.(result);
550
- }
551
- catch (err) {
552
- const transformedError = (0, transform_error_1.transformError)(err, {
553
- spreadPathsToArguments: {},
554
- explicitPathsToArguments: { campaignId: '$[0]', sendAt: '$[1]' },
555
- singleArgumentUnchanged: false,
556
- }, ['campaignId', 'sendAt']);
557
- sideEffects?.onError?.(err);
558
- throw transformedError;
559
- }
560
- }
561
- exports.reschedule = reschedule;
562
- /**
563
- * Permanently deletes a campaign.
564
- * @param campaignId - Campaign ID.
565
- * @public
566
- * @requiredField campaignId
567
- * @permissionId Shoutout.Manage
568
- * @permissionScope Manage Stores
569
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
570
- * @permissionScope Access Verticals by Automations
571
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
572
- * @permissionScope Set Up Automations
573
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
574
- * @permissionScope Manage Email Marketing
575
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
576
- * @applicableIdentity APP
577
- * @fqn wix.emailmarketing.api.v1.CampaignService._delete
578
- */
579
- async function deleteCampaign(campaignId) {
580
- // @ts-ignore
581
- const { httpClient, sideEffects } = arguments[1];
582
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
583
- campaignId: campaignId,
584
- });
585
- const reqOpts = ambassadorWixEmailMarketingV1Campaign._delete(payload);
586
- sideEffects?.onSiteCall?.();
587
- try {
588
- const result = await httpClient.request(reqOpts);
589
- sideEffects?.onSuccess?.(result);
590
- }
591
- catch (err) {
592
- const transformedError = (0, transform_error_1.transformError)(err, {
593
- spreadPathsToArguments: {},
594
- explicitPathsToArguments: { campaignId: '$[0]' },
595
- singleArgumentUnchanged: false,
596
- }, ['campaignId']);
597
- sideEffects?.onError?.(err);
598
- throw transformedError;
599
- }
600
- }
601
- exports.deleteCampaign = deleteCampaign;
602
- /**
603
- * Creates a copy of an existing campaign.
604
- * @param campaignId - ID of the message to be duplicated.
605
- * @public
606
- * @requiredField campaignId
607
- * @permissionId Shoutout.Manage
608
- * @permissionScope Manage Stores
609
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
610
- * @permissionScope Access Verticals by Automations
611
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
612
- * @permissionScope Set Up Automations
613
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
614
- * @permissionScope Manage Email Marketing
615
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
616
- * @applicableIdentity APP
617
- * @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
618
- */
619
- async function reuseCampaign(campaignId) {
620
- // @ts-ignore
621
- const { httpClient, sideEffects } = arguments[1];
622
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
623
- campaignId: campaignId,
624
- });
625
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.reuse(payload);
626
- sideEffects?.onSiteCall?.();
627
- try {
628
- const result = await httpClient.request(reqOpts);
629
- sideEffects?.onSuccess?.(result);
630
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
631
- }
632
- catch (err) {
633
- const transformedError = (0, transform_error_1.transformError)(err, {
634
- spreadPathsToArguments: {},
635
- explicitPathsToArguments: { campaignId: '$[0]' },
636
- singleArgumentUnchanged: false,
637
- }, ['campaignId']);
638
- sideEffects?.onError?.(err);
639
- throw transformedError;
640
- }
641
- }
642
- exports.reuseCampaign = reuseCampaign;
643
- /**
644
- * Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.
645
- * @param campaignId - Campaign ID.
646
- * @public
647
- * @requiredField campaignId
648
- * @permissionId Shoutout.Manage
649
- * @permissionScope Manage Stores
650
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
651
- * @permissionScope Access Verticals by Automations
652
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
653
- * @permissionScope Set Up Automations
654
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
655
- * @permissionScope Manage Email Marketing
656
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
657
- * @applicableIdentity APP
658
- * @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
659
- */
660
- async function getAudience(campaignId) {
661
- // @ts-ignore
662
- const { httpClient, sideEffects } = arguments[1];
663
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
664
- campaignId: campaignId,
665
- });
666
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.getAudience(payload);
667
- sideEffects?.onSiteCall?.();
668
- try {
669
- const result = await httpClient.request(reqOpts);
670
- sideEffects?.onSuccess?.(result);
671
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
672
- }
673
- catch (err) {
674
- const transformedError = (0, transform_error_1.transformError)(err, {
675
- spreadPathsToArguments: {},
676
- explicitPathsToArguments: { campaignId: '$[0]' },
677
- singleArgumentUnchanged: false,
678
- }, ['campaignId']);
679
- sideEffects?.onError?.(err);
680
- throw transformedError;
681
- }
682
- }
683
- exports.getAudience = getAudience;
684
- /**
685
- * Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
686
- * @param emailAddress - Email address to verify.
687
- * @public
688
- * @requiredField emailAddress
689
- * @permissionId Shoutout.Manage
690
- * @permissionScope Manage Stores
691
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
692
- * @permissionScope Access Verticals by Automations
693
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
694
- * @permissionScope Set Up Automations
695
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
696
- * @permissionScope Manage Email Marketing
697
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
698
- * @applicableIdentity APP
699
- * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
700
- */
701
- async function identifySenderAddress(emailAddress) {
702
- // @ts-ignore
703
- const { httpClient, sideEffects } = arguments[1];
704
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
705
- emailAddress: emailAddress,
706
- });
707
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.identifySenderAddress(payload);
708
- sideEffects?.onSiteCall?.();
709
- try {
710
- const result = await httpClient.request(reqOpts);
711
- sideEffects?.onSuccess?.(result);
712
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
713
- }
714
- catch (err) {
715
- const transformedError = (0, transform_error_1.transformError)(err, {
716
- spreadPathsToArguments: {},
717
- explicitPathsToArguments: { emailAddress: '$[0]' },
718
- singleArgumentUnchanged: false,
719
- }, ['emailAddress']);
720
- sideEffects?.onError?.(err);
721
- throw transformedError;
722
- }
723
- }
724
- exports.identifySenderAddress = identifySenderAddress;
725
- /**
726
- * Validates any provided link. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
727
- *
728
- * If you provide a link as a placeholder, it's returned in a response as valid.
729
- * @param url - URL to validate.
730
- * @public
731
- * @requiredField url
732
- * @permissionId Shoutout.Manage
733
- * @permissionScope Manage Stores
734
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
735
- * @permissionScope Access Verticals by Automations
736
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
737
- * @permissionScope Set Up Automations
738
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
739
- * @permissionScope Manage Email Marketing
740
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
741
- * @applicableIdentity APP
742
- * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
743
- */
744
- async function validateLink(url) {
745
- // @ts-ignore
746
- const { httpClient, sideEffects } = arguments[1];
747
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ url: url });
748
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.validateLink(payload);
749
- sideEffects?.onSiteCall?.();
750
- try {
751
- const result = await httpClient.request(reqOpts);
752
- sideEffects?.onSuccess?.(result);
753
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
754
- }
755
- catch (err) {
756
- const transformedError = (0, transform_error_1.transformError)(err, {
757
- spreadPathsToArguments: {},
758
- explicitPathsToArguments: { url: '$[0]' },
759
- singleArgumentUnchanged: false,
760
- }, ['url']);
761
- sideEffects?.onError?.(err);
762
- throw transformedError;
763
- }
764
- }
765
- exports.validateLink = validateLink;
766
- /**
767
- * Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
768
- * @param html - HTML string with links.
769
- * @public
770
- * @requiredField html
771
- * @permissionId Shoutout.Manage
772
- * @permissionScope Manage Stores
773
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
774
- * @permissionScope Access Verticals by Automations
775
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
776
- * @permissionScope Set Up Automations
777
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
778
- * @permissionScope Manage Email Marketing
779
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
780
- * @applicableIdentity APP
781
- * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
782
- */
783
- async function validateHtmlLinks(html) {
784
- // @ts-ignore
785
- const { httpClient, sideEffects } = arguments[1];
786
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ html: html });
787
- const reqOpts = ambassadorWixEmailMarketingV1Campaign.validateHtmlLinks(payload);
788
- sideEffects?.onSiteCall?.();
789
- try {
790
- const result = await httpClient.request(reqOpts);
791
- sideEffects?.onSuccess?.(result);
792
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
793
- }
794
- catch (err) {
795
- const transformedError = (0, transform_error_1.transformError)(err, {
796
- spreadPathsToArguments: {},
797
- explicitPathsToArguments: { html: '$[0]' },
798
- singleArgumentUnchanged: false,
799
- }, ['html']);
800
- sideEffects?.onError?.(err);
801
- throw transformedError;
802
- }
803
- }
804
- exports.validateHtmlLinks = validateHtmlLinks;
805
- //# sourceMappingURL=email-marketing-v1-campaign-campaigns.universal.js.map