@wix/auto_sdk_email-subscriptions_email-subscriptions 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/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.d.ts +12 -0
  11. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js +20 -0
  12. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js.map +1 -0
  13. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.d.ts +41 -0
  14. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js +239 -0
  15. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js.map +1 -0
  16. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.d.ts +19 -0
  17. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js +123 -0
  18. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js.map +1 -0
  19. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.d.ts +64 -0
  20. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js +54 -0
  21. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js.map +1 -0
  22. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.d.ts +341 -0
  23. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js +38 -0
  24. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js.map +1 -0
  25. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.d.ts +455 -0
  26. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js +275 -0
  27. package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.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/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.d.ts +12 -0
  39. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js +14 -0
  40. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js.map +1 -0
  41. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.d.ts +41 -0
  42. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js +231 -0
  43. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js.map +1 -0
  44. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.d.ts +19 -0
  45. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js +92 -0
  46. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js.map +1 -0
  47. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.d.ts +64 -0
  48. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js +43 -0
  49. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js.map +1 -0
  50. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.d.ts +341 -0
  51. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js +35 -0
  52. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js.map +1 -0
  53. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.d.ts +455 -0
  54. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js +244 -0
  55. package/build/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.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/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.d.ts +14 -0
  66. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js +20 -0
  67. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js.map +1 -0
  68. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.d.ts +41 -0
  69. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js +239 -0
  70. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js.map +1 -0
  71. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.d.ts +19 -0
  72. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js +123 -0
  73. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js.map +1 -0
  74. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.d.ts +73 -0
  75. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js +54 -0
  76. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js.map +1 -0
  77. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.d.ts +341 -0
  78. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js +38 -0
  79. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js.map +1 -0
  80. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.d.ts +468 -0
  81. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js +275 -0
  82. package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.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/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.d.ts +14 -0
  93. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js +14 -0
  94. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js.map +1 -0
  95. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.d.ts +41 -0
  96. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js +231 -0
  97. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js.map +1 -0
  98. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.d.ts +19 -0
  99. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js +92 -0
  100. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js.map +1 -0
  101. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.d.ts +73 -0
  102. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js +43 -0
  103. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js.map +1 -0
  104. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.d.ts +341 -0
  105. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js +35 -0
  106. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js.map +1 -0
  107. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.d.ts +468 -0
  108. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js +244 -0
  109. package/build/internal/es/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,275 @@
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.generateUnsubscribeLink = exports.bulkUpsertEmailSubscription = exports.upsertEmailSubscription = exports.queryEmailSubscriptions = exports.getEmailSubscription = exports.WebhookIdentityType = exports.Status = exports.SubscriptionEnumStatus = 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 ambassadorWixEmailsubscriptionsV1Emailsubscription = __importStar(require("./emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js"));
30
+ var SubscriptionEnumStatus;
31
+ (function (SubscriptionEnumStatus) {
32
+ /** Undefined status. */
33
+ SubscriptionEnumStatus["UNKNOWN"] = "UNKNOWN";
34
+ /** No status specified. This is the default, initial value before any info about the email address is known. */
35
+ SubscriptionEnumStatus["NOT_SET"] = "NOT_SET";
36
+ /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
37
+ SubscriptionEnumStatus["PENDING"] = "PENDING";
38
+ /** Recipient has opted in to marketing emails. */
39
+ SubscriptionEnumStatus["SUBSCRIBED"] = "SUBSCRIBED";
40
+ /** Recipient has opted out of marketing emails. */
41
+ SubscriptionEnumStatus["UNSUBSCRIBED"] = "UNSUBSCRIBED";
42
+ })(SubscriptionEnumStatus || (exports.SubscriptionEnumStatus = SubscriptionEnumStatus = {}));
43
+ var Status;
44
+ (function (Status) {
45
+ /** No status specified. This is the initial default value before any info about the email address is known. */
46
+ Status["NOT_SET"] = "NOT_SET";
47
+ /** Emails to this email address are being delivered successfully. */
48
+ Status["VALID"] = "VALID";
49
+ /** The last email to the recipient bounced or was rejected. */
50
+ Status["BOUNCED"] = "BOUNCED";
51
+ /** The recipient registered a spam complaint with their email provider. */
52
+ Status["SPAM_COMPLAINT"] = "SPAM_COMPLAINT";
53
+ /** Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.) This status might impact subsequent emails sent to this address. */
54
+ Status["INACTIVE"] = "INACTIVE";
55
+ })(Status || (exports.Status = Status = {}));
56
+ var WebhookIdentityType;
57
+ (function (WebhookIdentityType) {
58
+ WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
59
+ WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
60
+ WebhookIdentityType["MEMBER"] = "MEMBER";
61
+ WebhookIdentityType["WIX_USER"] = "WIX_USER";
62
+ WebhookIdentityType["APP"] = "APP";
63
+ })(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
64
+ /**
65
+ * Get Email Subscription
66
+ * @internal
67
+ * @documentationMaturity preview
68
+ * @requiredField _id
69
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
70
+ * @permissionScope Manage Email Subscriptions
71
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
72
+ * @applicableIdentity APP
73
+ * @returns Returned email subscription
74
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription
75
+ */
76
+ async function getEmailSubscription(_id) {
77
+ // @ts-ignore
78
+ const { httpClient, sideEffects } = arguments[1];
79
+ const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ id: _id });
80
+ const reqOpts = ambassadorWixEmailsubscriptionsV1Emailsubscription.getEmailSubscription(payload);
81
+ sideEffects?.onSiteCall?.();
82
+ try {
83
+ const result = await httpClient.request(reqOpts);
84
+ sideEffects?.onSuccess?.(result);
85
+ return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data)
86
+ ?.emailSubscription;
87
+ }
88
+ catch (err) {
89
+ const transformedError = (0, transform_error_1.transformError)(err, {
90
+ spreadPathsToArguments: {},
91
+ explicitPathsToArguments: { id: '$[0]' },
92
+ singleArgumentUnchanged: false,
93
+ }, ['_id']);
94
+ sideEffects?.onError?.(err);
95
+ throw transformedError;
96
+ }
97
+ }
98
+ exports.getEmailSubscription = getEmailSubscription;
99
+ /**
100
+ * Retrieves email subscriptions,
101
+ * given the provided paging, filtering, and sorting.
102
+ *
103
+ * Currently, querying is supported on the `email` field
104
+ * with the `$in` array filter.
105
+ * For example, to query for emails "me@my.com" and "you@your.org",
106
+ * the filter should be formed like this:
107
+ *
108
+ * ```json
109
+ * { "filter": {
110
+ * "email": {
111
+ * "$in": ["me@my.com", "you@your.org"]
112
+ * }
113
+ * }
114
+ * }
115
+ * ```
116
+ *
117
+ * To learn how to query email subscriptions, see
118
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
119
+ * @param filter - Filter options.
120
+ * Currently, querying is supported on the `email` field
121
+ * with the `$in` array filter.
122
+ * @public
123
+ * @documentationMaturity preview
124
+ * @requiredField filter
125
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
126
+ * @permissionScope Manage Email Subscriptions
127
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
128
+ * @applicableIdentity APP
129
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions
130
+ */
131
+ async function queryEmailSubscriptions(filter, options) {
132
+ // @ts-ignore
133
+ const { httpClient, sideEffects } = arguments[2];
134
+ const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
135
+ filter: filter,
136
+ paging: options?.paging,
137
+ });
138
+ const reqOpts = ambassadorWixEmailsubscriptionsV1Emailsubscription.queryEmailSubscriptions(payload);
139
+ sideEffects?.onSiteCall?.();
140
+ try {
141
+ const result = await httpClient.request(reqOpts);
142
+ sideEffects?.onSuccess?.(result);
143
+ return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
144
+ }
145
+ catch (err) {
146
+ const transformedError = (0, transform_error_1.transformError)(err, {
147
+ spreadPathsToArguments: {},
148
+ explicitPathsToArguments: { filter: '$[0]', paging: '$[1].paging' },
149
+ singleArgumentUnchanged: false,
150
+ }, ['filter', 'options']);
151
+ sideEffects?.onError?.(err);
152
+ throw transformedError;
153
+ }
154
+ }
155
+ exports.queryEmailSubscriptions = queryEmailSubscriptions;
156
+ /**
157
+ * Updates or creates an email subscription for the requested email.
158
+ *
159
+ * An email subscription is always returned in the response,
160
+ * regardless of whether it was updated or created.
161
+ * @public
162
+ * @documentationMaturity preview
163
+ * @requiredField options.subscription.email
164
+ * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY
165
+ * @permissionScope Manage Email Subscriptions
166
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
167
+ * @applicableIdentity APP
168
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription
169
+ */
170
+ async function upsertEmailSubscription(options) {
171
+ // @ts-ignore
172
+ const { httpClient, sideEffects } = arguments[1];
173
+ const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
174
+ subscription: options?.subscription,
175
+ });
176
+ const reqOpts = ambassadorWixEmailsubscriptionsV1Emailsubscription.upsertEmailSubscription(payload);
177
+ sideEffects?.onSiteCall?.();
178
+ try {
179
+ const result = await httpClient.request(reqOpts);
180
+ sideEffects?.onSuccess?.(result);
181
+ return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
182
+ }
183
+ catch (err) {
184
+ const transformedError = (0, transform_error_1.transformError)(err, {
185
+ spreadPathsToArguments: {},
186
+ explicitPathsToArguments: { subscription: '$[0].subscription' },
187
+ singleArgumentUnchanged: false,
188
+ }, ['options']);
189
+ sideEffects?.onError?.(err);
190
+ throw transformedError;
191
+ }
192
+ }
193
+ exports.upsertEmailSubscription = upsertEmailSubscription;
194
+ /**
195
+ * Updates or creates multiple email subscriptions.
196
+ * @param subscriptions - List of email subscriptions to update or create.
197
+ * @public
198
+ * @documentationMaturity preview
199
+ * @requiredField subscriptions
200
+ * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY
201
+ * @permissionScope Manage Email Subscriptions
202
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
203
+ * @applicableIdentity APP
204
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription
205
+ */
206
+ async function bulkUpsertEmailSubscription(subscriptions) {
207
+ // @ts-ignore
208
+ const { httpClient, sideEffects } = arguments[1];
209
+ const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
210
+ subscriptions: subscriptions,
211
+ });
212
+ const reqOpts = ambassadorWixEmailsubscriptionsV1Emailsubscription.bulkUpsertEmailSubscription(payload);
213
+ sideEffects?.onSiteCall?.();
214
+ try {
215
+ const result = await httpClient.request(reqOpts);
216
+ sideEffects?.onSuccess?.(result);
217
+ return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
218
+ }
219
+ catch (err) {
220
+ const transformedError = (0, transform_error_1.transformError)(err, {
221
+ spreadPathsToArguments: {},
222
+ explicitPathsToArguments: { subscriptions: '$[0]' },
223
+ singleArgumentUnchanged: false,
224
+ }, ['subscriptions']);
225
+ sideEffects?.onError?.(err);
226
+ throw transformedError;
227
+ }
228
+ }
229
+ exports.bulkUpsertEmailSubscription = bulkUpsertEmailSubscription;
230
+ /**
231
+ * Creates an unsubscribe link to be shared with the relevant recipient.
232
+ *
233
+ * If someone clicks the **Unsubscribe** button on the confirmation page,
234
+ * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
235
+ * @param emailAddress - Email address the unsubscribe link is for.
236
+ * @public
237
+ * @documentationMaturity preview
238
+ * @requiredField emailAddress
239
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
240
+ * @permissionScope Manage Email Subscriptions
241
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
242
+ * @applicableIdentity APP
243
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink
244
+ */
245
+ async function generateUnsubscribeLink(emailAddress, options) {
246
+ // @ts-ignore
247
+ const { httpClient, sideEffects } = arguments[2];
248
+ const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
249
+ emailAddress: emailAddress,
250
+ metadata: options?.metadata,
251
+ language: options?.language,
252
+ });
253
+ const reqOpts = ambassadorWixEmailsubscriptionsV1Emailsubscription.generateUnsubscribeLink(payload);
254
+ sideEffects?.onSiteCall?.();
255
+ try {
256
+ const result = await httpClient.request(reqOpts);
257
+ sideEffects?.onSuccess?.(result);
258
+ return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
259
+ }
260
+ catch (err) {
261
+ const transformedError = (0, transform_error_1.transformError)(err, {
262
+ spreadPathsToArguments: {},
263
+ explicitPathsToArguments: {
264
+ emailAddress: '$[0]',
265
+ metadata: '$[1].metadata',
266
+ language: '$[1].language',
267
+ },
268
+ singleArgumentUnchanged: false,
269
+ }, ['emailAddress', 'options']);
270
+ sideEffects?.onError?.(err);
271
+ throw transformedError;
272
+ }
273
+ }
274
+ exports.generateUnsubscribeLink = generateUnsubscribeLink;
275
+ //# sourceMappingURL=emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js","sourceRoot":"","sources":["../../../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,0JAA4I;AAmC5I,IAAY,sBAWX;AAXD,WAAY,sBAAsB;IAChC,wBAAwB;IACxB,6CAAmB,CAAA;IACnB,gHAAgH;IAChH,6CAAmB,CAAA;IACnB,mFAAmF;IACnF,6CAAmB,CAAA;IACnB,kDAAkD;IAClD,mDAAyB,CAAA;IACzB,mDAAmD;IACnD,uDAA6B,CAAA;AAC/B,CAAC,EAXW,sBAAsB,sCAAtB,sBAAsB,QAWjC;AAED,IAAY,MAWX;AAXD,WAAY,MAAM;IAChB,+GAA+G;IAC/G,6BAAmB,CAAA;IACnB,qEAAqE;IACrE,yBAAe,CAAA;IACf,+DAA+D;IAC/D,6BAAmB,CAAA;IACnB,2EAA2E;IAC3E,2CAAiC,CAAA;IACjC,6NAA6N;IAC7N,+BAAqB,CAAA;AACvB,CAAC,EAXW,MAAM,sBAAN,MAAM,QAWjB;AAqRD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA0ED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,oBAAoB,CACxC,GAAW;IAEX,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAEnE,MAAM,OAAO,GACX,kDAAkD,CAAC,oBAAoB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACxC,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,CAAC,CACR,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,oDAqCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,KAAK,UAAU,uBAAuB,CAC3C,MAAkC,EAClC,OAAwC;IAKxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,kDAAkD,CAAC,uBAAuB,CACxE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE;YACnE,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,QAAQ,EAAE,SAAS,CAAC,CACtB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA3CD,0DA2CC;AAUD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,uBAAuB,CAC3C,OAAwC;IAKxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,YAAY,EAAE,OAAO,EAAE,YAAY;KACpC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,kDAAkD,CAAC,uBAAuB,CACxE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE;YAC/D,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAzCD,0DAyCC;AAOD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,2BAA2B,CAC/C,aAAkC;IAKlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,kDAAkD,CAAC,2BAA2B,CAC5E,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAzCD,kEAyCC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,uBAAuB,CAC3C,YAAoB,EACpB,OAAwC;IAKxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,YAAY,EAAE,YAAY;QAC1B,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,QAAQ,EAAE,OAAO,EAAE,QAAQ;KAC5B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,kDAAkD,CAAC,uBAAuB,CACxE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,YAAY,EAAE,MAAM;gBACpB,QAAQ,EAAE,eAAe;gBACzB,QAAQ,EAAE,eAAe;aAC1B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,cAAc,EAAE,SAAS,CAAC,CAC5B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAhDD,0DAgDC"}
@@ -0,0 +1 @@
1
+ export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js';
@@ -0,0 +1,2 @@
1
+ export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js';
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../index.ts"],"names":[],"mappings":"AAAA,cAAc,8EAA8E,CAAC"}
@@ -0,0 +1 @@
1
+ export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
@@ -0,0 +1,2 @@
1
+ export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
2
+ //# sourceMappingURL=index.typings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../../index.typings.ts"],"names":[],"mappings":"AAAA,cAAc,gFAAgF,CAAC"}
@@ -0,0 +1 @@
1
+ export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js';
@@ -0,0 +1,2 @@
1
+ export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.meta.js';
2
+ //# sourceMappingURL=meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../meta.ts"],"names":[],"mappings":"AAAA,cAAc,2EAA2E,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { getEmailSubscription as publicGetEmailSubscription, queryEmailSubscriptions as publicQueryEmailSubscriptions, upsertEmailSubscription as publicUpsertEmailSubscription, bulkUpsertEmailSubscription as publicBulkUpsertEmailSubscription, generateUnsubscribeLink as publicGenerateUnsubscribeLink } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js';
2
+ import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
3
+ import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
4
+ import { onEmailsubscriptionEmailSubscriptionChanged as publicOnEmailsubscriptionEmailSubscriptionChanged } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js';
5
+ /** @internal */
6
+ export declare const getEmailSubscription: MaybeContext<BuildRESTFunction<typeof publicGetEmailSubscription> & typeof publicGetEmailSubscription>;
7
+ export declare const queryEmailSubscriptions: MaybeContext<BuildRESTFunction<typeof publicQueryEmailSubscriptions> & typeof publicQueryEmailSubscriptions>;
8
+ export declare const upsertEmailSubscription: MaybeContext<BuildRESTFunction<typeof publicUpsertEmailSubscription> & typeof publicUpsertEmailSubscription>;
9
+ export declare const bulkUpsertEmailSubscription: MaybeContext<BuildRESTFunction<typeof publicBulkUpsertEmailSubscription> & typeof publicBulkUpsertEmailSubscription>;
10
+ export declare const generateUnsubscribeLink: MaybeContext<BuildRESTFunction<typeof publicGenerateUnsubscribeLink> & typeof publicGenerateUnsubscribeLink>;
11
+ /** */
12
+ export declare const onEmailsubscriptionEmailSubscriptionChanged: ReturnType<typeof createEventModule<typeof publicOnEmailsubscriptionEmailSubscriptionChanged>>;
13
+ export { SubscriptionEnumStatus, Status, WebhookIdentityType, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
14
+ export { EmailSubscription, V1RenderUnsubscribePageRequest, RawHttpResponse, HeadersEntry, V1ConfirmUnsubscribeActionRequest, Empty, EmailSubscriptionChanged, GetEmailSubscriptionRequest, GetEmailSubscriptionResponse, UpdateEmailSubscriptionRequest, UpdateEmailSubscriptionResponse, QueryEmailSubscriptionsRequest, Paging, QueryEmailSubscriptionsResponse, PagingMetadata, UpsertEmailSubscriptionRequest, UpsertEmailSubscriptionResponse, BulkUpsertEmailSubscriptionRequest, BulkUpsertEmailSubscriptionResponse, BulkUpsertEmailSubscriptionResult, Error, Metadata, GenerateUnsubscribeLinkRequest, GenerateUnsubscribeLinkResponse, RenderUnsubscribePageRequest, ConfirmUnsubscribeActionRequest, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, EmailSubscriptionNonNullableFields, GetEmailSubscriptionResponseNonNullableFields, QueryEmailSubscriptionsResponseNonNullableFields, UpsertEmailSubscriptionResponseNonNullableFields, BulkUpsertEmailSubscriptionResponseNonNullableFields, GenerateUnsubscribeLinkResponseNonNullableFields, BaseEventMetadata, EmailsubscriptionEmailSubscriptionChangedEnvelope, QueryEmailSubscriptionsOptions, UpsertEmailSubscriptionOptions, GenerateUnsubscribeLinkOptions, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
@@ -0,0 +1,14 @@
1
+ import { getEmailSubscription as publicGetEmailSubscription, queryEmailSubscriptions as publicQueryEmailSubscriptions, upsertEmailSubscription as publicUpsertEmailSubscription, bulkUpsertEmailSubscription as publicBulkUpsertEmailSubscription, generateUnsubscribeLink as publicGenerateUnsubscribeLink, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js';
2
+ import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
3
+ import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
4
+ import { onEmailsubscriptionEmailSubscriptionChanged as publicOnEmailsubscriptionEmailSubscriptionChanged } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.public.js';
5
+ /** @internal */
6
+ export const getEmailSubscription = /*#__PURE__*/ createRESTModule(publicGetEmailSubscription);
7
+ export const queryEmailSubscriptions = /*#__PURE__*/ createRESTModule(publicQueryEmailSubscriptions);
8
+ export const upsertEmailSubscription = /*#__PURE__*/ createRESTModule(publicUpsertEmailSubscription);
9
+ export const bulkUpsertEmailSubscription = /*#__PURE__*/ createRESTModule(publicBulkUpsertEmailSubscription);
10
+ export const generateUnsubscribeLink = /*#__PURE__*/ createRESTModule(publicGenerateUnsubscribeLink);
11
+ /** */
12
+ export const onEmailsubscriptionEmailSubscriptionChanged = createEventModule(publicOnEmailsubscriptionEmailSubscriptionChanged);
13
+ export { SubscriptionEnumStatus, Status, WebhookIdentityType, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
14
+ //# sourceMappingURL=emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailsubscriptions-v1-emailsubscription-email-subscriptions.context.js","sourceRoot":"","sources":["../../../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,IAAI,0BAA0B,EAClD,uBAAuB,IAAI,6BAA6B,EACxD,uBAAuB,IAAI,6BAA6B,EACxD,2BAA2B,IAAI,iCAAiC,EAChE,uBAAuB,IAAI,6BAA6B,GACzD,MAAM,yEAAyE,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAE9E,OAAO,EAAE,2CAA2C,IAAI,iDAAiD,EAAE,MAAM,yEAAyE,CAAC;AAE3L,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAG7B,aAAa,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,CAAC;AAC/D,MAAM,CAAC,MAAM,uBAAuB,GAGhC,aAAa,CAAC,gBAAgB,CAAC,6BAA6B,CAAC,CAAC;AAClE,MAAM,CAAC,MAAM,uBAAuB,GAGhC,aAAa,CAAC,gBAAgB,CAAC,6BAA6B,CAAC,CAAC;AAClE,MAAM,CAAC,MAAM,2BAA2B,GAGpC,aAAa,CAAC,gBAAgB,CAAC,iCAAiC,CAAC,CAAC;AACtE,MAAM,CAAC,MAAM,uBAAuB,GAGhC,aAAa,CAAC,gBAAgB,CAAC,6BAA6B,CAAC,CAAC;AAClE,MAAM;AACN,MAAM,CAAC,MAAM,2CAA2C,GAIpD,iBAAiB,CAAC,iDAAiD,CAAC,CAAC;AAEzE,OAAO,EACL,sBAAsB,EACtB,MAAM,EACN,mBAAmB,GACpB,MAAM,4EAA4E,CAAC"}
@@ -0,0 +1,41 @@
1
+ import { RequestOptionsFactory } from '@wix/sdk-types';
2
+ /** Get Email Subscription */
3
+ export declare function getEmailSubscription(payload: object): RequestOptionsFactory<any>;
4
+ /**
5
+ * Retrieves email subscriptions,
6
+ * given the provided paging, filtering, and sorting.
7
+ *
8
+ * Currently, querying is supported on the `email` field
9
+ * with the `$in` array filter.
10
+ * For example, to query for emails "me@my.com" and "you@your.org",
11
+ * the filter should be formed like this:
12
+ *
13
+ * ```json
14
+ * { "filter": {
15
+ * "email": {
16
+ * "$in": ["me@my.com", "you@your.org"]
17
+ * }
18
+ * }
19
+ * }
20
+ * ```
21
+ *
22
+ * To learn how to query email subscriptions, see
23
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
24
+ */
25
+ export declare function queryEmailSubscriptions(payload: object): RequestOptionsFactory<any>;
26
+ /**
27
+ * Updates or creates an email subscription for the requested email.
28
+ *
29
+ * An email subscription is always returned in the response,
30
+ * regardless of whether it was updated or created.
31
+ */
32
+ export declare function upsertEmailSubscription(payload: object): RequestOptionsFactory<any>;
33
+ /** Updates or creates multiple email subscriptions. */
34
+ export declare function bulkUpsertEmailSubscription(payload: object): RequestOptionsFactory<any>;
35
+ /**
36
+ * Creates an unsubscribe link to be shared with the relevant recipient.
37
+ *
38
+ * If someone clicks the **Unsubscribe** button on the confirmation page,
39
+ * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
40
+ */
41
+ export declare function generateUnsubscribeLink(payload: object): RequestOptionsFactory<any>;
@@ -0,0 +1,231 @@
1
+ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
2
+ import { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
3
+ import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
4
+ import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
5
+ import { resolveUrl } from '@wix/sdk-runtime/rest-modules';
6
+ function resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl(opts) {
7
+ const domainToMappings = {
8
+ 'editor._base_domain_': [
9
+ {
10
+ srcPath: '/_api/email-marketing/v1/email-subscriptions',
11
+ destPath: '/v1/email-subscriptions',
12
+ },
13
+ ],
14
+ 'blocks._base_domain_': [
15
+ {
16
+ srcPath: '/_api/email-marketing/v1/email-subscriptions',
17
+ destPath: '/v1/email-subscriptions',
18
+ },
19
+ ],
20
+ 'create.editorx': [
21
+ {
22
+ srcPath: '/_api/email-marketing/v1/email-subscriptions',
23
+ destPath: '/v1/email-subscriptions',
24
+ },
25
+ ],
26
+ 'manage._base_domain_': [
27
+ {
28
+ srcPath: '/_api/email-marketing/v1/email-subscriptions',
29
+ destPath: '/v1/email-subscriptions',
30
+ },
31
+ ],
32
+ 'www._base_domain_': [
33
+ {
34
+ srcPath: '/_api/email-marketing/v1/email-subscriptions',
35
+ destPath: '/v1/email-subscriptions',
36
+ },
37
+ ],
38
+ 'www.wixapis.com': [
39
+ {
40
+ srcPath: '/email-marketing/v1/email-subscriptions',
41
+ destPath: '/v1/email-subscriptions',
42
+ },
43
+ {
44
+ srcPath: '/email-marketing/v1/email-subscriptions/unsubscribe-link',
45
+ destPath: '/v1/email-subscriptions/unsubscribe-link',
46
+ },
47
+ ],
48
+ };
49
+ return resolveUrl(Object.assign(opts, { domainToMappings }));
50
+ }
51
+ const PACKAGE_NAME = '@wix/auto_sdk_email-subscriptions_email-subscriptions';
52
+ /** Get Email Subscription */
53
+ export function getEmailSubscription(payload) {
54
+ function __getEmailSubscription({ host }) {
55
+ const metadata = {
56
+ entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
57
+ method: 'GET',
58
+ methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription',
59
+ packageName: PACKAGE_NAME,
60
+ url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
61
+ protoPath: '/v1/email-subscriptions/{id}',
62
+ data: payload,
63
+ host,
64
+ }),
65
+ params: toURLSearchParams(payload),
66
+ transformResponse: (payload) => transformPaths(payload, [
67
+ {
68
+ transformFn: transformRESTTimestampToSDKTimestamp,
69
+ paths: [
70
+ { path: 'emailSubscription.createdDate' },
71
+ { path: 'emailSubscription.updatedDate' },
72
+ ],
73
+ },
74
+ ]),
75
+ };
76
+ return metadata;
77
+ }
78
+ return __getEmailSubscription;
79
+ }
80
+ /**
81
+ * Retrieves email subscriptions,
82
+ * given the provided paging, filtering, and sorting.
83
+ *
84
+ * Currently, querying is supported on the `email` field
85
+ * with the `$in` array filter.
86
+ * For example, to query for emails "me@my.com" and "you@your.org",
87
+ * the filter should be formed like this:
88
+ *
89
+ * ```json
90
+ * { "filter": {
91
+ * "email": {
92
+ * "$in": ["me@my.com", "you@your.org"]
93
+ * }
94
+ * }
95
+ * }
96
+ * ```
97
+ *
98
+ * To learn how to query email subscriptions, see
99
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
100
+ */
101
+ export function queryEmailSubscriptions(payload) {
102
+ function __queryEmailSubscriptions({ host }) {
103
+ const metadata = {
104
+ entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
105
+ method: 'POST',
106
+ methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions',
107
+ packageName: PACKAGE_NAME,
108
+ url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
109
+ protoPath: '/v1/email-subscriptions/query',
110
+ data: payload,
111
+ host,
112
+ }),
113
+ data: payload,
114
+ transformResponse: (payload) => transformPaths(payload, [
115
+ {
116
+ transformFn: transformRESTTimestampToSDKTimestamp,
117
+ paths: [
118
+ { path: 'subscriptions.createdDate' },
119
+ { path: 'subscriptions.updatedDate' },
120
+ ],
121
+ },
122
+ ]),
123
+ };
124
+ return metadata;
125
+ }
126
+ return __queryEmailSubscriptions;
127
+ }
128
+ /**
129
+ * Updates or creates an email subscription for the requested email.
130
+ *
131
+ * An email subscription is always returned in the response,
132
+ * regardless of whether it was updated or created.
133
+ */
134
+ export function upsertEmailSubscription(payload) {
135
+ function __upsertEmailSubscription({ host }) {
136
+ const serializedData = transformPaths(payload, [
137
+ {
138
+ transformFn: transformSDKTimestampToRESTTimestamp,
139
+ paths: [
140
+ { path: 'subscription.createdDate' },
141
+ { path: 'subscription.updatedDate' },
142
+ ],
143
+ },
144
+ ]);
145
+ const metadata = {
146
+ entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
147
+ method: 'POST',
148
+ methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription',
149
+ packageName: PACKAGE_NAME,
150
+ url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
151
+ protoPath: '/v1/email-subscriptions',
152
+ data: serializedData,
153
+ host,
154
+ }),
155
+ data: serializedData,
156
+ transformResponse: (payload) => transformPaths(payload, [
157
+ {
158
+ transformFn: transformRESTTimestampToSDKTimestamp,
159
+ paths: [
160
+ { path: 'subscription.createdDate' },
161
+ { path: 'subscription.updatedDate' },
162
+ ],
163
+ },
164
+ ]),
165
+ };
166
+ return metadata;
167
+ }
168
+ return __upsertEmailSubscription;
169
+ }
170
+ /** Updates or creates multiple email subscriptions. */
171
+ export function bulkUpsertEmailSubscription(payload) {
172
+ function __bulkUpsertEmailSubscription({ host }) {
173
+ const serializedData = transformPaths(payload, [
174
+ {
175
+ transformFn: transformSDKTimestampToRESTTimestamp,
176
+ paths: [
177
+ { path: 'subscriptions.createdDate' },
178
+ { path: 'subscriptions.updatedDate' },
179
+ ],
180
+ },
181
+ ]);
182
+ const metadata = {
183
+ entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
184
+ method: 'POST',
185
+ methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription',
186
+ packageName: PACKAGE_NAME,
187
+ url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
188
+ protoPath: '/v1/email-subscriptions/bulk',
189
+ data: serializedData,
190
+ host,
191
+ }),
192
+ data: serializedData,
193
+ transformResponse: (payload) => transformPaths(payload, [
194
+ {
195
+ transformFn: transformRESTTimestampToSDKTimestamp,
196
+ paths: [
197
+ { path: 'results.emailSubscription.createdDate' },
198
+ { path: 'results.emailSubscription.updatedDate' },
199
+ ],
200
+ },
201
+ ]),
202
+ };
203
+ return metadata;
204
+ }
205
+ return __bulkUpsertEmailSubscription;
206
+ }
207
+ /**
208
+ * Creates an unsubscribe link to be shared with the relevant recipient.
209
+ *
210
+ * If someone clicks the **Unsubscribe** button on the confirmation page,
211
+ * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
212
+ */
213
+ export function generateUnsubscribeLink(payload) {
214
+ function __generateUnsubscribeLink({ host }) {
215
+ const metadata = {
216
+ entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
217
+ method: 'POST',
218
+ methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink',
219
+ packageName: PACKAGE_NAME,
220
+ url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
221
+ protoPath: '/v1/email-subscriptions/unsubscribe-link',
222
+ data: payload,
223
+ host,
224
+ }),
225
+ data: payload,
226
+ };
227
+ return metadata;
228
+ }
229
+ return __generateUnsubscribeLink;
230
+ }
231
+ //# sourceMappingURL=emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js","sourceRoot":"","sources":["../../../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAI3D,SAAS,kEAAkE,CACzE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,yBAAyB;aACpC;YACD;gBACE,OAAO,EAAE,0DAA0D;gBACnE,QAAQ,EAAE,0CAA0C;aACrD;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,uDAAuD,CAAC;AAE7E,6BAA6B;AAC7B,MAAM,UAAU,oBAAoB,CAClC,OAAe;IAEf,SAAS,sBAAsB,CAAC,EAAE,IAAI,EAAO;QAC3C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,mFAAmF;YACrF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,8BAA8B;gBACzC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sFAAsF;YACxF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,+BAA+B;gBAC1C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;wBACrC,EAAE,IAAI,EAAE,2BAA2B,EAAE;qBACtC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;oBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;iBACrC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sFAAsF;YACxF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,2BAA2B,CACzC,OAAe;IAEf,SAAS,6BAA6B,CAAC,EAAE,IAAI,EAAO;QAClD,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;oBACrC,EAAE,IAAI,EAAE,2BAA2B,EAAE;iBACtC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0FAA0F;YAC5F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,8BAA8B;gBACzC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,uCAAuC,EAAE;wBACjD,EAAE,IAAI,EAAE,uCAAuC,EAAE;qBAClD;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sFAAsF;YACxF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC"}