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