@wix/auto_sdk_events_orders 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/events-v1-order-orders.context.d.ts +42 -0
  11. package/build/cjs/src/events-v1-order-orders.context.js +62 -0
  12. package/build/cjs/src/events-v1-order-orders.context.js.map +1 -0
  13. package/build/cjs/src/events-v1-order-orders.http.d.ts +97 -0
  14. package/build/cjs/src/events-v1-order-orders.http.js +1635 -0
  15. package/build/cjs/src/events-v1-order-orders.http.js.map +1 -0
  16. package/build/cjs/src/events-v1-order-orders.meta.d.ts +49 -0
  17. package/build/cjs/src/events-v1-order-orders.meta.js +351 -0
  18. package/build/cjs/src/events-v1-order-orders.meta.js.map +1 -0
  19. package/build/cjs/src/events-v1-order-orders.public.d.ts +202 -0
  20. package/build/cjs/src/events-v1-order-orders.public.js +248 -0
  21. package/build/cjs/src/events-v1-order-orders.public.js.map +1 -0
  22. package/build/cjs/src/events-v1-order-orders.types.d.ts +1854 -0
  23. package/build/cjs/src/events-v1-order-orders.types.js +178 -0
  24. package/build/cjs/src/events-v1-order-orders.types.js.map +1 -0
  25. package/build/cjs/src/events-v1-order-orders.universal.d.ts +2536 -0
  26. package/build/cjs/src/events-v1-order-orders.universal.js +1146 -0
  27. package/build/cjs/src/events-v1-order-orders.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/events-v1-order-orders.context.d.ts +42 -0
  39. package/build/es/src/events-v1-order-orders.context.js +42 -0
  40. package/build/es/src/events-v1-order-orders.context.js.map +1 -0
  41. package/build/es/src/events-v1-order-orders.http.d.ts +97 -0
  42. package/build/es/src/events-v1-order-orders.http.js +1615 -0
  43. package/build/es/src/events-v1-order-orders.http.js.map +1 -0
  44. package/build/es/src/events-v1-order-orders.meta.d.ts +49 -0
  45. package/build/es/src/events-v1-order-orders.meta.js +308 -0
  46. package/build/es/src/events-v1-order-orders.meta.js.map +1 -0
  47. package/build/es/src/events-v1-order-orders.public.d.ts +202 -0
  48. package/build/es/src/events-v1-order-orders.public.js +211 -0
  49. package/build/es/src/events-v1-order-orders.public.js.map +1 -0
  50. package/build/es/src/events-v1-order-orders.types.d.ts +1854 -0
  51. package/build/es/src/events-v1-order-orders.types.js +175 -0
  52. package/build/es/src/events-v1-order-orders.types.js.map +1 -0
  53. package/build/es/src/events-v1-order-orders.universal.d.ts +2536 -0
  54. package/build/es/src/events-v1-order-orders.universal.js +1103 -0
  55. package/build/es/src/events-v1-order-orders.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/events-v1-order-orders.context.d.ts +42 -0
  66. package/build/internal/cjs/src/events-v1-order-orders.context.js +62 -0
  67. package/build/internal/cjs/src/events-v1-order-orders.context.js.map +1 -0
  68. package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +97 -0
  69. package/build/internal/cjs/src/events-v1-order-orders.http.js +1635 -0
  70. package/build/internal/cjs/src/events-v1-order-orders.http.js.map +1 -0
  71. package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +49 -0
  72. package/build/internal/cjs/src/events-v1-order-orders.meta.js +351 -0
  73. package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +1 -0
  74. package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +202 -0
  75. package/build/internal/cjs/src/events-v1-order-orders.public.js +248 -0
  76. package/build/internal/cjs/src/events-v1-order-orders.public.js.map +1 -0
  77. package/build/internal/cjs/src/events-v1-order-orders.types.d.ts +1854 -0
  78. package/build/internal/cjs/src/events-v1-order-orders.types.js +178 -0
  79. package/build/internal/cjs/src/events-v1-order-orders.types.js.map +1 -0
  80. package/build/internal/cjs/src/events-v1-order-orders.universal.d.ts +2536 -0
  81. package/build/internal/cjs/src/events-v1-order-orders.universal.js +1146 -0
  82. package/build/internal/cjs/src/events-v1-order-orders.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/events-v1-order-orders.context.d.ts +42 -0
  93. package/build/internal/es/src/events-v1-order-orders.context.js +42 -0
  94. package/build/internal/es/src/events-v1-order-orders.context.js.map +1 -0
  95. package/build/internal/es/src/events-v1-order-orders.http.d.ts +97 -0
  96. package/build/internal/es/src/events-v1-order-orders.http.js +1615 -0
  97. package/build/internal/es/src/events-v1-order-orders.http.js.map +1 -0
  98. package/build/internal/es/src/events-v1-order-orders.meta.d.ts +49 -0
  99. package/build/internal/es/src/events-v1-order-orders.meta.js +308 -0
  100. package/build/internal/es/src/events-v1-order-orders.meta.js.map +1 -0
  101. package/build/internal/es/src/events-v1-order-orders.public.d.ts +202 -0
  102. package/build/internal/es/src/events-v1-order-orders.public.js +211 -0
  103. package/build/internal/es/src/events-v1-order-orders.public.js.map +1 -0
  104. package/build/internal/es/src/events-v1-order-orders.types.d.ts +1854 -0
  105. package/build/internal/es/src/events-v1-order-orders.types.js +175 -0
  106. package/build/internal/es/src/events-v1-order-orders.types.js.map +1 -0
  107. package/build/internal/es/src/events-v1-order-orders.universal.d.ts +2536 -0
  108. package/build/internal/es/src/events-v1-order-orders.universal.js +1103 -0
  109. package/build/internal/es/src/events-v1-order-orders.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1103 @@
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 ambassadorWixEventsV1Order from './events-v1-order-orders.http.js';
4
+ import { transformSDKAddressToRESTAddress } from '@wix/sdk-runtime/transformations/address';
5
+ import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
6
+ import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
7
+ export var SubdivisionType;
8
+ (function (SubdivisionType) {
9
+ SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
10
+ /** State */
11
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
12
+ /** County */
13
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
14
+ /** City/town */
15
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
16
+ /** Neighborhood/quarter */
17
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
18
+ /** Street/block */
19
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_5"] = "ADMINISTRATIVE_AREA_LEVEL_5";
20
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
21
+ SubdivisionType["COUNTRY"] = "COUNTRY";
22
+ })(SubdivisionType || (SubdivisionType = {}));
23
+ export var OrderStatus;
24
+ (function (OrderStatus) {
25
+ /** Order status not available for this request fieldset. */
26
+ OrderStatus["NA_ORDER_STATUS"] = "NA_ORDER_STATUS";
27
+ /** Order is confirmed and payment isn't required. */
28
+ OrderStatus["FREE"] = "FREE";
29
+ /** Order is paid for but the payment gateway has suspended the payment. */
30
+ OrderStatus["PENDING"] = "PENDING";
31
+ /** Order is paid via a payment gateway. */
32
+ OrderStatus["PAID"] = "PAID";
33
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
34
+ OrderStatus["OFFLINE_PENDING"] = "OFFLINE_PENDING";
35
+ /** Order is awaiting payment at the cashier. */
36
+ OrderStatus["INITIATED"] = "INITIATED";
37
+ /** Order is canceled. */
38
+ OrderStatus["CANCELED"] = "CANCELED";
39
+ /** Order payment is declined. */
40
+ OrderStatus["DECLINED"] = "DECLINED";
41
+ /** Order payment is authorized. */
42
+ OrderStatus["AUTHORIZED"] = "AUTHORIZED";
43
+ /** Order payment is voided. */
44
+ OrderStatus["VOIDED"] = "VOIDED";
45
+ /** Order is partially paid with less than the total amount. */
46
+ OrderStatus["PARTIALLY_PAID"] = "PARTIALLY_PAID";
47
+ })(OrderStatus || (OrderStatus = {}));
48
+ export var ChannelType;
49
+ (function (ChannelType) {
50
+ /** Buyer created the order via an online channel such as a website or mobile app. */
51
+ ChannelType["ONLINE"] = "ONLINE";
52
+ /** Sales person created the order and collected the money. */
53
+ ChannelType["OFFLINE_POS"] = "OFFLINE_POS";
54
+ })(ChannelType || (ChannelType = {}));
55
+ export var TaxType;
56
+ (function (TaxType) {
57
+ /** Tax is included in the ticket price. */
58
+ TaxType["INCLUDED"] = "INCLUDED";
59
+ /** Tax is added to the order at the checkout. */
60
+ TaxType["ADDED"] = "ADDED";
61
+ /** Tax is added to the final total at the checkout. */
62
+ TaxType["ADDED_AT_CHECKOUT"] = "ADDED_AT_CHECKOUT";
63
+ })(TaxType || (TaxType = {}));
64
+ export var FeeName;
65
+ (function (FeeName) {
66
+ /** Wix ticket service fee charges applied to the line item. */
67
+ FeeName["WIX_FEE"] = "WIX_FEE";
68
+ })(FeeName || (FeeName = {}));
69
+ export var FeeType;
70
+ (function (FeeType) {
71
+ /** Fee is added to the ticket price at checkout. */
72
+ FeeType["FEE_ADDED"] = "FEE_ADDED";
73
+ /** Seller absorbs the fee. It is deducted from the ticket price. */
74
+ FeeType["FEE_INCLUDED"] = "FEE_INCLUDED";
75
+ /** Fee is added to the ticket price at checkout. */
76
+ FeeType["FEE_ADDED_AT_CHECKOUT"] = "FEE_ADDED_AT_CHECKOUT";
77
+ })(FeeType || (FeeType = {}));
78
+ export var ScheduledActionEnumAction;
79
+ (function (ScheduledActionEnumAction) {
80
+ /** Action not scheduled. */
81
+ ScheduledActionEnumAction["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
82
+ /** Captured after the delay. */
83
+ ScheduledActionEnumAction["CAPTURE"] = "CAPTURE";
84
+ /** Void after the delay. */
85
+ ScheduledActionEnumAction["VOID"] = "VOID";
86
+ })(ScheduledActionEnumAction || (ScheduledActionEnumAction = {}));
87
+ export var Action;
88
+ (function (Action) {
89
+ /** Order can be archived. */
90
+ Action["ARCHIVE"] = "ARCHIVE";
91
+ /** Order can be unarchived. */
92
+ Action["UNARCHIVE"] = "UNARCHIVE";
93
+ /** Order can be confirmed. */
94
+ Action["CONFIRM"] = "CONFIRM";
95
+ /** Order can be captured. */
96
+ Action["CAPTURE"] = "CAPTURE";
97
+ /** Order can be voided. */
98
+ Action["VOID"] = "VOID";
99
+ })(Action || (Action = {}));
100
+ export var OrderType;
101
+ (function (OrderType) {
102
+ /** Buyer form is used for all tickets. */
103
+ OrderType["UNASSIGNED_TICKETS"] = "UNASSIGNED_TICKETS";
104
+ /** Each order ticket has its own form. */
105
+ OrderType["ASSIGNED_TICKETS"] = "ASSIGNED_TICKETS";
106
+ })(OrderType || (OrderType = {}));
107
+ export var OrderFieldset;
108
+ (function (OrderFieldset) {
109
+ /** Include tickets in response. */
110
+ OrderFieldset["TICKETS"] = "TICKETS";
111
+ /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
112
+ OrderFieldset["DETAILS"] = "DETAILS";
113
+ /** Include `checkoutForm` in the response. */
114
+ OrderFieldset["FORM"] = "FORM";
115
+ /** Include `invoice` in the response. */
116
+ OrderFieldset["INVOICE"] = "INVOICE";
117
+ })(OrderFieldset || (OrderFieldset = {}));
118
+ export var OrderTag;
119
+ (function (OrderTag) {
120
+ /** Return only confirmed orders. */
121
+ OrderTag["CONFIRMED"] = "CONFIRMED";
122
+ /** Return only unconfirmed orders. */
123
+ OrderTag["UNCONFIRMED"] = "UNCONFIRMED";
124
+ /** Return only member orders. */
125
+ OrderTag["MEMBER"] = "MEMBER";
126
+ /** Return only archived orders. */
127
+ OrderTag["ARCHIVED"] = "ARCHIVED";
128
+ /** Return only non archived orders. */
129
+ OrderTag["NON_ARCHIVED"] = "NON_ARCHIVED";
130
+ /** Return only orders with all guests checked-in. */
131
+ OrderTag["FULLY_CHECKED_IN"] = "FULLY_CHECKED_IN";
132
+ /** Return only orders with no guests checked-in. */
133
+ OrderTag["NOT_FULLY_CHECKED_IN"] = "NOT_FULLY_CHECKED_IN";
134
+ })(OrderTag || (OrderTag = {}));
135
+ export var WebhookIdentityType;
136
+ (function (WebhookIdentityType) {
137
+ WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
138
+ WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
139
+ WebhookIdentityType["MEMBER"] = "MEMBER";
140
+ WebhookIdentityType["WIX_USER"] = "WIX_USER";
141
+ WebhookIdentityType["APP"] = "APP";
142
+ })(WebhookIdentityType || (WebhookIdentityType = {}));
143
+ export var ReservationStatus;
144
+ (function (ReservationStatus) {
145
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
146
+ ReservationStatus["RESERVATION_PENDING"] = "RESERVATION_PENDING";
147
+ /** The reservation is confirmed and will not expire. */
148
+ ReservationStatus["RESERVATION_CONFIRMED"] = "RESERVATION_CONFIRMED";
149
+ /** The reservation is canceled because of non payment. */
150
+ ReservationStatus["RESERVATION_CANCELED"] = "RESERVATION_CANCELED";
151
+ /** The reservation is canceled manually by the buyer. */
152
+ ReservationStatus["RESERVATION_CANCELED_MANUALLY"] = "RESERVATION_CANCELED_MANUALLY";
153
+ /** The reservation is expired. */
154
+ ReservationStatus["RESERVATION_EXPIRED"] = "RESERVATION_EXPIRED";
155
+ })(ReservationStatus || (ReservationStatus = {}));
156
+ export var State;
157
+ (function (State) {
158
+ State["INCLUDE_HIDDEN_NOT_ON_SALE"] = "INCLUDE_HIDDEN_NOT_ON_SALE";
159
+ })(State || (State = {}));
160
+ export var TicketSaleStatus;
161
+ (function (TicketSaleStatus) {
162
+ /** Ticket sale is scheduled to start. */
163
+ TicketSaleStatus["SALE_SCHEDULED"] = "SALE_SCHEDULED";
164
+ /** Ticket sale has started. */
165
+ TicketSaleStatus["SALE_STARTED"] = "SALE_STARTED";
166
+ /** Ticket sale has ended. */
167
+ TicketSaleStatus["SALE_ENDED"] = "SALE_ENDED";
168
+ })(TicketSaleStatus || (TicketSaleStatus = {}));
169
+ export var Type;
170
+ (function (Type) {
171
+ Type["STANDARD"] = "STANDARD";
172
+ Type["DONATION"] = "DONATION";
173
+ })(Type || (Type = {}));
174
+ export var TicketDefinitionFieldset;
175
+ (function (TicketDefinitionFieldset) {
176
+ /** Include `policy` in the response. */
177
+ TicketDefinitionFieldset["POLICY"] = "POLICY";
178
+ /** Include `dashboard` in the response. */
179
+ TicketDefinitionFieldset["DASHBOARD"] = "DASHBOARD";
180
+ })(TicketDefinitionFieldset || (TicketDefinitionFieldset = {}));
181
+ /**
182
+ * Retrieves a list of orders, including ticket data.
183
+ * @public
184
+ * @param options - An object representing the available options for retrieving a list of orders.
185
+ * @permissionId WIX_EVENTS.READ_ORDERS
186
+ * @permissionScope Read Events - all read permissions
187
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
188
+ * @permissionScope Manage Events - all permissions
189
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
190
+ * @permissionScope Read Basic Events Order Info
191
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
192
+ * @permissionScope Manage Orders
193
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
194
+ * @applicableIdentity APP
195
+ * @fqn wix.events.ticketing.OrderManagement.ListOrders
196
+ */
197
+ export async function listOrders(options) {
198
+ // @ts-ignore
199
+ const { httpClient, sideEffects } = arguments[1];
200
+ const payload = renameKeysFromSDKRequestToRESTRequest({
201
+ offset: options?.offset,
202
+ limit: options?.limit,
203
+ fieldset: options?.fieldset,
204
+ status: options?.status,
205
+ eventId: options?.eventId,
206
+ orderNumber: options?.orderNumber,
207
+ memberId: options?.memberId,
208
+ facet: options?.facet,
209
+ searchPhrase: options?.searchPhrase,
210
+ eventCreatorId: options?.eventCreatorId,
211
+ sort: options?.sort,
212
+ tag: options?.tag,
213
+ contactId: options?.contactId,
214
+ });
215
+ const reqOpts = ambassadorWixEventsV1Order.listOrders(payload);
216
+ sideEffects?.onSiteCall?.();
217
+ try {
218
+ const result = await httpClient.request(reqOpts);
219
+ sideEffects?.onSuccess?.(result);
220
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
221
+ {
222
+ transformFn: transformRESTAddressToSDKAddress,
223
+ paths: [
224
+ { path: 'orders.checkoutForm.inputValues.address.address' },
225
+ {
226
+ path: 'orders.tickets.guestDetails.form.inputValues.address.address',
227
+ },
228
+ ],
229
+ },
230
+ ]));
231
+ }
232
+ catch (err) {
233
+ const transformedError = sdkTransformError(err, {
234
+ spreadPathsToArguments: {},
235
+ explicitPathsToArguments: {
236
+ offset: '$[0].offset',
237
+ limit: '$[0].limit',
238
+ fieldset: '$[0].fieldset',
239
+ status: '$[0].status',
240
+ eventId: '$[0].eventId',
241
+ orderNumber: '$[0].orderNumber',
242
+ memberId: '$[0].memberId',
243
+ facet: '$[0].facet',
244
+ searchPhrase: '$[0].searchPhrase',
245
+ eventCreatorId: '$[0].eventCreatorId',
246
+ sort: '$[0].sort',
247
+ tag: '$[0].tag',
248
+ contactId: '$[0].contactId',
249
+ },
250
+ singleArgumentUnchanged: false,
251
+ }, ['options']);
252
+ sideEffects?.onError?.(err);
253
+ throw transformedError;
254
+ }
255
+ }
256
+ /**
257
+ * Retrieves an order, including ticket data.
258
+ * <!--
259
+ * >The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
260
+ * -->
261
+ * @public
262
+ * @requiredField identifiers
263
+ * @requiredField identifiers.eventId
264
+ * @requiredField identifiers.orderNumber
265
+ * @param options - An object representing the available options for getting an order.
266
+ * @param identifiers - An object containing identifiers for the order to be retrieved.
267
+ * @permissionId WIX_EVENTS.READ_ORDERS
268
+ * @permissionScope Read Events - all read permissions
269
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
270
+ * @permissionScope Manage Events - all permissions
271
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
272
+ * @permissionScope Read Basic Events Order Info
273
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
274
+ * @permissionScope Manage Orders
275
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
276
+ * @applicableIdentity APP
277
+ * @returns Requested order.
278
+ * @fqn wix.events.ticketing.OrderManagement.GetOrder
279
+ */
280
+ export async function getOrder(identifiers, options) {
281
+ // @ts-ignore
282
+ const { httpClient, sideEffects } = arguments[2];
283
+ const payload = renameKeysFromSDKRequestToRESTRequest({
284
+ eventId: identifiers?.eventId,
285
+ orderNumber: identifiers?.orderNumber,
286
+ fieldset: options?.fieldset,
287
+ });
288
+ const reqOpts = ambassadorWixEventsV1Order.getOrder(payload);
289
+ sideEffects?.onSiteCall?.();
290
+ try {
291
+ const result = await httpClient.request(reqOpts);
292
+ sideEffects?.onSuccess?.(result);
293
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
294
+ {
295
+ transformFn: transformRESTAddressToSDKAddress,
296
+ paths: [
297
+ { path: 'order.checkoutForm.inputValues.address.address' },
298
+ {
299
+ path: 'order.tickets.guestDetails.form.inputValues.address.address',
300
+ },
301
+ ],
302
+ },
303
+ ]))?.order;
304
+ }
305
+ catch (err) {
306
+ const transformedError = sdkTransformError(err, {
307
+ spreadPathsToArguments: {},
308
+ explicitPathsToArguments: {
309
+ eventId: '$[0].eventId',
310
+ orderNumber: '$[0].orderNumber',
311
+ fieldset: '$[1].fieldset',
312
+ },
313
+ singleArgumentUnchanged: false,
314
+ }, ['identifiers', 'options']);
315
+ sideEffects?.onError?.(err);
316
+ throw transformedError;
317
+ }
318
+ }
319
+ /**
320
+ * Updates an order.
321
+ * @public
322
+ * @requiredField identifiers
323
+ * @requiredField identifiers.eventId
324
+ * @requiredField identifiers.orderNumber
325
+ * @param options - An object representing the available options for updating an order.
326
+ * @param identifiers - An object containing identifiers for the order to be updated.
327
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
328
+ * @permissionScope Manage Events - all permissions
329
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
330
+ * @permissionScope Manage Orders
331
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
332
+ * @applicableIdentity APP
333
+ * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
334
+ */
335
+ export async function updateOrder(identifiers, options) {
336
+ // @ts-ignore
337
+ const { httpClient, sideEffects } = arguments[2];
338
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
339
+ eventId: identifiers?.eventId,
340
+ orderNumber: identifiers?.orderNumber,
341
+ fields: options?.fields,
342
+ checkoutForm: options?.checkoutForm,
343
+ archived: options?.archived,
344
+ }), [
345
+ {
346
+ transformFn: transformSDKAddressToRESTAddress,
347
+ paths: [{ path: 'checkoutForm.inputValues.address.address' }],
348
+ },
349
+ ]);
350
+ const reqOpts = ambassadorWixEventsV1Order.updateOrder(payload);
351
+ sideEffects?.onSiteCall?.();
352
+ try {
353
+ const result = await httpClient.request(reqOpts);
354
+ sideEffects?.onSuccess?.(result);
355
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
356
+ {
357
+ transformFn: transformRESTAddressToSDKAddress,
358
+ paths: [
359
+ { path: 'order.checkoutForm.inputValues.address.address' },
360
+ {
361
+ path: 'order.tickets.guestDetails.form.inputValues.address.address',
362
+ },
363
+ ],
364
+ },
365
+ ]));
366
+ }
367
+ catch (err) {
368
+ const transformedError = sdkTransformError(err, {
369
+ spreadPathsToArguments: {},
370
+ explicitPathsToArguments: {
371
+ eventId: '$[0].eventId',
372
+ orderNumber: '$[0].orderNumber',
373
+ fields: '$[1].fields',
374
+ checkoutForm: '$[1].checkoutForm',
375
+ archived: '$[1].archived',
376
+ },
377
+ singleArgumentUnchanged: false,
378
+ }, ['identifiers', 'options']);
379
+ sideEffects?.onError?.(err);
380
+ throw transformedError;
381
+ }
382
+ }
383
+ /**
384
+ * Archives multiple orders.
385
+ * @public
386
+ * @requiredField eventId
387
+ * @param options - An object representing the available options for confirming an order.
388
+ * @param eventId - Event ID to which the order belongs.
389
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
390
+ * @permissionScope Manage Events - all permissions
391
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
392
+ * @permissionScope Manage Orders
393
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
394
+ * @applicableIdentity APP
395
+ * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
396
+ */
397
+ export async function bulkUpdateOrders(eventId, options) {
398
+ // @ts-ignore
399
+ const { httpClient, sideEffects } = arguments[2];
400
+ const payload = renameKeysFromSDKRequestToRESTRequest({
401
+ eventId: eventId,
402
+ orderNumber: options?.orderNumber,
403
+ fields: options?.fields,
404
+ archived: options?.archived,
405
+ });
406
+ const reqOpts = ambassadorWixEventsV1Order.bulkUpdateOrders(payload);
407
+ sideEffects?.onSiteCall?.();
408
+ try {
409
+ const result = await httpClient.request(reqOpts);
410
+ sideEffects?.onSuccess?.(result);
411
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
412
+ {
413
+ transformFn: transformRESTAddressToSDKAddress,
414
+ paths: [
415
+ { path: 'orders.checkoutForm.inputValues.address.address' },
416
+ {
417
+ path: 'orders.tickets.guestDetails.form.inputValues.address.address',
418
+ },
419
+ ],
420
+ },
421
+ ]));
422
+ }
423
+ catch (err) {
424
+ const transformedError = sdkTransformError(err, {
425
+ spreadPathsToArguments: {},
426
+ explicitPathsToArguments: {
427
+ eventId: '$[0]',
428
+ orderNumber: '$[1].orderNumber',
429
+ fields: '$[1].fields',
430
+ archived: '$[1].archived',
431
+ },
432
+ singleArgumentUnchanged: false,
433
+ }, ['eventId', 'options']);
434
+ sideEffects?.onError?.(err);
435
+ throw transformedError;
436
+ }
437
+ }
438
+ /**
439
+ * Confirms an order.
440
+ *
441
+ *
442
+ * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
443
+ * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
444
+ * @public
445
+ * @requiredField eventId
446
+ * @param options - An object representing the available options for confirming an order.
447
+ * @param eventId - Event ID to which the order belongs.
448
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
449
+ * @permissionScope Manage Events - all permissions
450
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
451
+ * @permissionScope Manage Orders
452
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
453
+ * @applicableIdentity APP
454
+ * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
455
+ */
456
+ export async function confirmOrder(eventId, options) {
457
+ // @ts-ignore
458
+ const { httpClient, sideEffects } = arguments[2];
459
+ const payload = renameKeysFromSDKRequestToRESTRequest({
460
+ eventId: eventId,
461
+ orderNumber: options?.orderNumber,
462
+ });
463
+ const reqOpts = ambassadorWixEventsV1Order.confirmOrder(payload);
464
+ sideEffects?.onSiteCall?.();
465
+ try {
466
+ const result = await httpClient.request(reqOpts);
467
+ sideEffects?.onSuccess?.(result);
468
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
469
+ {
470
+ transformFn: transformRESTAddressToSDKAddress,
471
+ paths: [
472
+ { path: 'orders.checkoutForm.inputValues.address.address' },
473
+ {
474
+ path: 'orders.tickets.guestDetails.form.inputValues.address.address',
475
+ },
476
+ ],
477
+ },
478
+ ]));
479
+ }
480
+ catch (err) {
481
+ const transformedError = sdkTransformError(err, {
482
+ spreadPathsToArguments: {},
483
+ explicitPathsToArguments: {
484
+ eventId: '$[0]',
485
+ orderNumber: '$[1].orderNumber',
486
+ },
487
+ singleArgumentUnchanged: false,
488
+ }, ['eventId', 'options']);
489
+ sideEffects?.onError?.(err);
490
+ throw transformedError;
491
+ }
492
+ }
493
+ /**
494
+ * Retrieves a summary of total ticket sales.
495
+ * <!--
496
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
497
+ * -->
498
+ * @public
499
+ * @param options - An object representing the available options for retrieving a summary of total ticket sales.
500
+ * @permissionId WIX_EVENTS.READ_ORDERS
501
+ * @permissionScope Read Events - all read permissions
502
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
503
+ * @permissionScope Manage Events - all permissions
504
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
505
+ * @permissionScope Read Basic Events Order Info
506
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
507
+ * @permissionScope Manage Orders
508
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
509
+ * @applicableIdentity APP
510
+ * @fqn wix.events.ticketing.OrderManagement.GetSummary
511
+ */
512
+ export async function getSummary(options) {
513
+ // @ts-ignore
514
+ const { httpClient, sideEffects } = arguments[1];
515
+ const payload = renameKeysFromSDKRequestToRESTRequest({
516
+ eventId: options?.eventId,
517
+ });
518
+ const reqOpts = ambassadorWixEventsV1Order.getSummary(payload);
519
+ sideEffects?.onSiteCall?.();
520
+ try {
521
+ const result = await httpClient.request(reqOpts);
522
+ sideEffects?.onSuccess?.(result);
523
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
524
+ }
525
+ catch (err) {
526
+ const transformedError = sdkTransformError(err, {
527
+ spreadPathsToArguments: {},
528
+ explicitPathsToArguments: { eventId: '$[0].eventId' },
529
+ singleArgumentUnchanged: false,
530
+ }, ['options']);
531
+ sideEffects?.onError?.(err);
532
+ throw transformedError;
533
+ }
534
+ }
535
+ /**
536
+ * Captures authorized payment asynchronously.
537
+ * Eventually order will become paid.
538
+ * For orders with non-authorized payments request will fail.
539
+ * @param orderNumber - Order number.
540
+ * @public
541
+ * @requiredField orderNumber
542
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
543
+ * @permissionScope Manage Events - all permissions
544
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
545
+ * @permissionScope Manage Orders
546
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
547
+ * @applicableIdentity APP
548
+ * @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
549
+ */
550
+ export async function captureAuthorizedPayment(orderNumber, options) {
551
+ // @ts-ignore
552
+ const { httpClient, sideEffects } = arguments[2];
553
+ const payload = renameKeysFromSDKRequestToRESTRequest({
554
+ orderNumber: orderNumber,
555
+ eventId: options?.eventId,
556
+ });
557
+ const reqOpts = ambassadorWixEventsV1Order.captureAuthorizedPayment(payload);
558
+ sideEffects?.onSiteCall?.();
559
+ try {
560
+ const result = await httpClient.request(reqOpts);
561
+ sideEffects?.onSuccess?.(result);
562
+ }
563
+ catch (err) {
564
+ const transformedError = sdkTransformError(err, {
565
+ spreadPathsToArguments: {},
566
+ explicitPathsToArguments: {
567
+ orderNumber: '$[0]',
568
+ eventId: '$[1].eventId',
569
+ },
570
+ singleArgumentUnchanged: false,
571
+ }, ['orderNumber', 'options']);
572
+ sideEffects?.onError?.(err);
573
+ throw transformedError;
574
+ }
575
+ }
576
+ /**
577
+ * Voids authorized payment asynchronously.
578
+ * Eventually order will become voided.
579
+ * For orders with non-authorized payments request will fail.
580
+ * @param orderNumber - Order number.
581
+ * @public
582
+ * @requiredField orderNumber
583
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
584
+ * @permissionScope Manage Events - all permissions
585
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
586
+ * @permissionScope Manage Orders
587
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
588
+ * @applicableIdentity APP
589
+ * @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
590
+ */
591
+ export async function voidAuthorizedPayment(orderNumber, options) {
592
+ // @ts-ignore
593
+ const { httpClient, sideEffects } = arguments[2];
594
+ const payload = renameKeysFromSDKRequestToRESTRequest({
595
+ orderNumber: orderNumber,
596
+ eventId: options?.eventId,
597
+ });
598
+ const reqOpts = ambassadorWixEventsV1Order.voidAuthorizedPayment(payload);
599
+ sideEffects?.onSiteCall?.();
600
+ try {
601
+ const result = await httpClient.request(reqOpts);
602
+ sideEffects?.onSuccess?.(result);
603
+ }
604
+ catch (err) {
605
+ const transformedError = sdkTransformError(err, {
606
+ spreadPathsToArguments: {},
607
+ explicitPathsToArguments: {
608
+ orderNumber: '$[0]',
609
+ eventId: '$[1].eventId',
610
+ },
611
+ singleArgumentUnchanged: false,
612
+ }, ['orderNumber', 'options']);
613
+ sideEffects?.onError?.(err);
614
+ throw transformedError;
615
+ }
616
+ }
617
+ /**
618
+ * Retrieves checkout details.
619
+ * @public
620
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
621
+ * @permissionScope Manage Events - all permissions
622
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
623
+ * @permissionScope Manage Orders
624
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
625
+ * @applicableIdentity APP
626
+ * @applicableIdentity VISITOR
627
+ * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
628
+ */
629
+ export async function getCheckoutOptions() {
630
+ // @ts-ignore
631
+ const { httpClient, sideEffects } = arguments[0];
632
+ const payload = renameKeysFromSDKRequestToRESTRequest({});
633
+ const reqOpts = ambassadorWixEventsV1Order.getCheckoutOptions(payload);
634
+ sideEffects?.onSiteCall?.();
635
+ try {
636
+ const result = await httpClient.request(reqOpts);
637
+ sideEffects?.onSuccess?.(result);
638
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
639
+ }
640
+ catch (err) {
641
+ const transformedError = sdkTransformError(err, {
642
+ spreadPathsToArguments: {},
643
+ explicitPathsToArguments: {},
644
+ singleArgumentUnchanged: false,
645
+ }, []);
646
+ sideEffects?.onError?.(err);
647
+ throw transformedError;
648
+ }
649
+ }
650
+ /**
651
+ * Returns tickets available to reserve.
652
+ * <!--
653
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
654
+ * -->
655
+ * @public
656
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
657
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
658
+ * @permissionScope Manage Events - all permissions
659
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
660
+ * @permissionScope Manage Orders
661
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
662
+ * @applicableIdentity APP
663
+ * @applicableIdentity VISITOR
664
+ * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
665
+ */
666
+ export async function listAvailableTickets(options) {
667
+ // @ts-ignore
668
+ const { httpClient, sideEffects } = arguments[1];
669
+ const payload = renameKeysFromSDKRequestToRESTRequest({
670
+ eventId: options?.eventId,
671
+ offset: options?.offset,
672
+ limit: options?.limit,
673
+ sort: options?.sort,
674
+ state: options?.state,
675
+ });
676
+ const reqOpts = ambassadorWixEventsV1Order.listAvailableTickets(payload);
677
+ sideEffects?.onSiteCall?.();
678
+ try {
679
+ const result = await httpClient.request(reqOpts);
680
+ sideEffects?.onSuccess?.(result);
681
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
682
+ }
683
+ catch (err) {
684
+ const transformedError = sdkTransformError(err, {
685
+ spreadPathsToArguments: {},
686
+ explicitPathsToArguments: {
687
+ eventId: '$[0].eventId',
688
+ offset: '$[0].offset',
689
+ limit: '$[0].limit',
690
+ sort: '$[0].sort',
691
+ state: '$[0].state',
692
+ },
693
+ singleArgumentUnchanged: false,
694
+ }, ['options']);
695
+ sideEffects?.onError?.(err);
696
+ throw transformedError;
697
+ }
698
+ }
699
+ /**
700
+ * Returns tickets available to reserve.
701
+ * <!--
702
+ * > Note: The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
703
+ * -->
704
+ * @public
705
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
706
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
707
+ * @permissionScope Manage Events - all permissions
708
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
709
+ * @permissionScope Manage Orders
710
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
711
+ * @applicableIdentity APP
712
+ * @applicableIdentity VISITOR
713
+ * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
714
+ */
715
+ export async function queryAvailableTickets(options) {
716
+ // @ts-ignore
717
+ const { httpClient, sideEffects } = arguments[1];
718
+ const payload = renameKeysFromSDKRequestToRESTRequest({
719
+ offset: options?.offset,
720
+ limit: options?.limit,
721
+ filter: options?.filter,
722
+ fieldset: options?.fieldset,
723
+ sort: options?.sort,
724
+ });
725
+ const reqOpts = ambassadorWixEventsV1Order.queryAvailableTickets(payload);
726
+ sideEffects?.onSiteCall?.();
727
+ try {
728
+ const result = await httpClient.request(reqOpts);
729
+ sideEffects?.onSuccess?.(result);
730
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
731
+ }
732
+ catch (err) {
733
+ const transformedError = sdkTransformError(err, {
734
+ spreadPathsToArguments: {},
735
+ explicitPathsToArguments: {
736
+ offset: '$[0].offset',
737
+ limit: '$[0].limit',
738
+ filter: '$[0].filter',
739
+ fieldset: '$[0].fieldset',
740
+ sort: '$[0].sort',
741
+ },
742
+ singleArgumentUnchanged: false,
743
+ }, ['options']);
744
+ sideEffects?.onError?.(err);
745
+ throw transformedError;
746
+ }
747
+ }
748
+ /**
749
+ * Reserves tickets for 20 minutes.
750
+ *
751
+ *
752
+ * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
753
+ * When the reservation expires, the tickets are added back to the stock.
754
+ * @public
755
+ * @requiredField eventId
756
+ * @param options - An object representing the available options for creating a reservation.
757
+ * @param eventId - Event ID to which the reservation belongs.
758
+ * @permissionId WIX_EVENTS.CHECKOUT
759
+ * @permissionScope Manage Events - all permissions
760
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
761
+ * @permissionScope Manage Orders
762
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
763
+ * @applicableIdentity APP
764
+ * @applicableIdentity VISITOR
765
+ * @fqn wix.events.ticketing.CheckoutService.CreateReservation
766
+ */
767
+ export async function createReservation(eventId, options) {
768
+ // @ts-ignore
769
+ const { httpClient, sideEffects } = arguments[2];
770
+ const payload = renameKeysFromSDKRequestToRESTRequest({
771
+ eventId: eventId,
772
+ ticketQuantities: options?.ticketQuantities,
773
+ ignoreLimits: options?.ignoreLimits,
774
+ allowHiddenTickets: options?.allowHiddenTickets,
775
+ });
776
+ const reqOpts = ambassadorWixEventsV1Order.createReservation(payload);
777
+ sideEffects?.onSiteCall?.();
778
+ try {
779
+ const result = await httpClient.request(reqOpts);
780
+ sideEffects?.onSuccess?.(result);
781
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
782
+ }
783
+ catch (err) {
784
+ const transformedError = sdkTransformError(err, {
785
+ spreadPathsToArguments: {},
786
+ explicitPathsToArguments: {
787
+ eventId: '$[0]',
788
+ ticketQuantities: '$[1].ticketQuantities',
789
+ ignoreLimits: '$[1].ignoreLimits',
790
+ allowHiddenTickets: '$[1].allowHiddenTickets',
791
+ },
792
+ singleArgumentUnchanged: false,
793
+ }, ['eventId', 'options']);
794
+ sideEffects?.onError?.(err);
795
+ throw transformedError;
796
+ }
797
+ }
798
+ /**
799
+ * Cancels ticket reservation and returns tickets to stock.
800
+ * <!--
801
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
802
+ * -->
803
+ * @param _id - Reservation ID.
804
+ * @public
805
+ * @requiredField _id
806
+ * @requiredField eventId
807
+ * @param identifiers - An object containing identifiers for the reservation to be cancelled.
808
+ * @param eventId - Event ID to which the reservation belongs.
809
+ * @permissionId WIX_EVENTS.CHECKOUT
810
+ * @permissionScope Manage Events - all permissions
811
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
812
+ * @permissionScope Manage Orders
813
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
814
+ * @applicableIdentity APP
815
+ * @applicableIdentity VISITOR
816
+ * @fqn wix.events.ticketing.CheckoutService.CancelReservation
817
+ */
818
+ export async function cancelReservation(_id, eventId) {
819
+ // @ts-ignore
820
+ const { httpClient, sideEffects } = arguments[2];
821
+ const payload = renameKeysFromSDKRequestToRESTRequest({
822
+ id: _id,
823
+ eventId: eventId,
824
+ });
825
+ const reqOpts = ambassadorWixEventsV1Order.cancelReservation(payload);
826
+ sideEffects?.onSiteCall?.();
827
+ try {
828
+ const result = await httpClient.request(reqOpts);
829
+ sideEffects?.onSuccess?.(result);
830
+ }
831
+ catch (err) {
832
+ const transformedError = sdkTransformError(err, {
833
+ spreadPathsToArguments: {},
834
+ explicitPathsToArguments: { id: '$[0]', eventId: '$[1]' },
835
+ singleArgumentUnchanged: false,
836
+ }, ['_id', 'eventId']);
837
+ sideEffects?.onError?.(err);
838
+ throw transformedError;
839
+ }
840
+ }
841
+ /**
842
+ * Generates a preview of an invoice, including the given coupon or pricing plan.
843
+ * @param reservationId - Reservation ID.
844
+ * @public
845
+ * @requiredField eventId
846
+ * @requiredField reservationId
847
+ * @param options - An object representing the available options for generating a preview of a reservation invoice.
848
+ * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
849
+ * @param eventId - Event ID to which the invoice belongs.
850
+ * @permissionId WIX_EVENTS.READ_INVOICE
851
+ * @permissionScope Read Events - all read permissions
852
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
853
+ * @permissionScope Manage Events - all permissions
854
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
855
+ * @permissionScope Read Basic Events Order Info
856
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
857
+ * @permissionScope Manage Orders
858
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
859
+ * @applicableIdentity APP
860
+ * @applicableIdentity VISITOR
861
+ * @fqn wix.events.ticketing.CheckoutService.GetInvoice
862
+ */
863
+ export async function getInvoice(reservationId, eventId, options) {
864
+ // @ts-ignore
865
+ const { httpClient, sideEffects } = arguments[3];
866
+ const payload = renameKeysFromSDKRequestToRESTRequest({
867
+ reservationId: reservationId,
868
+ eventId: eventId,
869
+ withDiscount: options?.withDiscount,
870
+ paidPlanBenefit: options?.paidPlanBenefit,
871
+ });
872
+ const reqOpts = ambassadorWixEventsV1Order.getInvoice(payload);
873
+ sideEffects?.onSiteCall?.();
874
+ try {
875
+ const result = await httpClient.request(reqOpts);
876
+ sideEffects?.onSuccess?.(result);
877
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
878
+ }
879
+ catch (err) {
880
+ const transformedError = sdkTransformError(err, {
881
+ spreadPathsToArguments: {},
882
+ explicitPathsToArguments: {
883
+ reservationId: '$[0]',
884
+ eventId: '$[1]',
885
+ withDiscount: '$[2].withDiscount',
886
+ paidPlanBenefit: '$[2].paidPlanBenefit',
887
+ },
888
+ singleArgumentUnchanged: false,
889
+ }, ['reservationId', 'eventId', 'options']);
890
+ sideEffects?.onError?.(err);
891
+ throw transformedError;
892
+ }
893
+ }
894
+ /**
895
+ * Checkouts the reserved tickets.
896
+ *
897
+ *
898
+ * Creates an order and associates it with a site visitor contact.
899
+ * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
900
+ *
901
+ * There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.
902
+ * To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:
903
+ * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
904
+ *
905
+ * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
906
+ * @public
907
+ * @requiredField eventId
908
+ * @requiredField options.guests.form
909
+ * @param options - An object representing the available options for checking out a reserved ticket.
910
+ * @param eventId - Event ID to which the checkout belongs.
911
+ * @permissionId WIX_EVENTS.CHECKOUT
912
+ * @permissionScope Manage Events - all permissions
913
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
914
+ * @permissionScope Manage Orders
915
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
916
+ * @applicableIdentity APP
917
+ * @applicableIdentity VISITOR
918
+ * @fqn wix.events.ticketing.CheckoutService.Checkout
919
+ */
920
+ export async function checkout(eventId, options) {
921
+ // @ts-ignore
922
+ const { httpClient, sideEffects } = arguments[2];
923
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
924
+ eventId: eventId,
925
+ reservationId: options?.reservationId,
926
+ memberId: options?.memberId,
927
+ discount: options?.discount,
928
+ buyer: options?.buyer,
929
+ guests: options?.guests,
930
+ paidPlanBenefit: options?.paidPlanBenefit,
931
+ options: options?.options,
932
+ marketingConsent: options?.marketingConsent,
933
+ }), [
934
+ {
935
+ transformFn: transformSDKAddressToRESTAddress,
936
+ paths: [{ path: 'guests.form.inputValues.address.address' }],
937
+ },
938
+ ]);
939
+ const reqOpts = ambassadorWixEventsV1Order.checkout(payload);
940
+ sideEffects?.onSiteCall?.();
941
+ try {
942
+ const result = await httpClient.request(reqOpts);
943
+ sideEffects?.onSuccess?.(result);
944
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
945
+ {
946
+ transformFn: transformRESTAddressToSDKAddress,
947
+ paths: [
948
+ { path: 'order.checkoutForm.inputValues.address.address' },
949
+ {
950
+ path: 'order.tickets.guestDetails.form.inputValues.address.address',
951
+ },
952
+ ],
953
+ },
954
+ ]));
955
+ }
956
+ catch (err) {
957
+ const transformedError = sdkTransformError(err, {
958
+ spreadPathsToArguments: {},
959
+ explicitPathsToArguments: {
960
+ eventId: '$[0]',
961
+ reservationId: '$[1].reservationId',
962
+ memberId: '$[1].memberId',
963
+ discount: '$[1].discount',
964
+ buyer: '$[1].buyer',
965
+ guests: '$[1].guests',
966
+ paidPlanBenefit: '$[1].paidPlanBenefit',
967
+ options: '$[1].options',
968
+ marketingConsent: '$[1].marketingConsent',
969
+ },
970
+ singleArgumentUnchanged: false,
971
+ }, ['eventId', 'options']);
972
+ sideEffects?.onError?.(err);
973
+ throw transformedError;
974
+ }
975
+ }
976
+ /**
977
+ * Updates order and tickets.
978
+ *
979
+ *
980
+ * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
981
+ * @param orderNumber - Unique order number.
982
+ * @public
983
+ * @requiredField eventId
984
+ * @requiredField orderNumber
985
+ * @param options - An object representing the available options for updating an order and tickets.
986
+ * @param identifiers - An object containing identifiers for the order and tickets to be updated.
987
+ * @param eventId - Event ID to which the checkout belongs.
988
+ * @permissionId WIX_EVENTS.CHECKOUT
989
+ * @permissionScope Manage Events - all permissions
990
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
991
+ * @permissionScope Manage Orders
992
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
993
+ * @applicableIdentity APP
994
+ * @applicableIdentity VISITOR
995
+ * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
996
+ */
997
+ export async function updateCheckout(orderNumber, eventId, options) {
998
+ // @ts-ignore
999
+ const { httpClient, sideEffects } = arguments[3];
1000
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1001
+ orderNumber: orderNumber,
1002
+ eventId: eventId,
1003
+ buyer: options?.buyer,
1004
+ guests: options?.guests,
1005
+ memberId: options?.memberId,
1006
+ discount: options?.discount,
1007
+ paidPlanBenefit: options?.paidPlanBenefit,
1008
+ }), [
1009
+ {
1010
+ transformFn: transformSDKAddressToRESTAddress,
1011
+ paths: [{ path: 'guests.form.inputValues.address.address' }],
1012
+ },
1013
+ ]);
1014
+ const reqOpts = ambassadorWixEventsV1Order.updateCheckout(payload);
1015
+ sideEffects?.onSiteCall?.();
1016
+ try {
1017
+ const result = await httpClient.request(reqOpts);
1018
+ sideEffects?.onSuccess?.(result);
1019
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1020
+ {
1021
+ transformFn: transformRESTAddressToSDKAddress,
1022
+ paths: [
1023
+ { path: 'order.checkoutForm.inputValues.address.address' },
1024
+ {
1025
+ path: 'order.tickets.guestDetails.form.inputValues.address.address',
1026
+ },
1027
+ ],
1028
+ },
1029
+ ]));
1030
+ }
1031
+ catch (err) {
1032
+ const transformedError = sdkTransformError(err, {
1033
+ spreadPathsToArguments: {},
1034
+ explicitPathsToArguments: {
1035
+ orderNumber: '$[0]',
1036
+ eventId: '$[1]',
1037
+ buyer: '$[2].buyer',
1038
+ guests: '$[2].guests',
1039
+ memberId: '$[2].memberId',
1040
+ discount: '$[2].discount',
1041
+ paidPlanBenefit: '$[2].paidPlanBenefit',
1042
+ },
1043
+ singleArgumentUnchanged: false,
1044
+ }, ['orderNumber', 'eventId', 'options']);
1045
+ sideEffects?.onError?.(err);
1046
+ throw transformedError;
1047
+ }
1048
+ }
1049
+ /**
1050
+ * Creates order with payment details already initiated via Cashier Pay API.
1051
+ * @public
1052
+ * @documentationMaturity preview
1053
+ * @requiredField eventId
1054
+ * @requiredField options.reservationId
1055
+ * @param eventId - Event ID to which the checkout belongs.
1056
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
1057
+ * @permissionScope Manage Events - all permissions
1058
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1059
+ * @permissionScope Manage Orders
1060
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
1061
+ * @applicableIdentity APP
1062
+ * @fqn wix.events.ticketing.CheckoutService.PosCheckout
1063
+ */
1064
+ export async function posCheckout(eventId, options) {
1065
+ // @ts-ignore
1066
+ const { httpClient, sideEffects } = arguments[2];
1067
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1068
+ eventId: eventId,
1069
+ reservationId: options?.reservationId,
1070
+ paymentDetailsId: options?.paymentDetailsId,
1071
+ });
1072
+ const reqOpts = ambassadorWixEventsV1Order.posCheckout(payload);
1073
+ sideEffects?.onSiteCall?.();
1074
+ try {
1075
+ const result = await httpClient.request(reqOpts);
1076
+ sideEffects?.onSuccess?.(result);
1077
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1078
+ {
1079
+ transformFn: transformRESTAddressToSDKAddress,
1080
+ paths: [
1081
+ { path: 'order.checkoutForm.inputValues.address.address' },
1082
+ {
1083
+ path: 'order.tickets.guestDetails.form.inputValues.address.address',
1084
+ },
1085
+ ],
1086
+ },
1087
+ ]));
1088
+ }
1089
+ catch (err) {
1090
+ const transformedError = sdkTransformError(err, {
1091
+ spreadPathsToArguments: {},
1092
+ explicitPathsToArguments: {
1093
+ eventId: '$[0]',
1094
+ reservationId: '$[1].reservationId',
1095
+ paymentDetailsId: '$[1].paymentDetailsId',
1096
+ },
1097
+ singleArgumentUnchanged: false,
1098
+ }, ['eventId', 'options']);
1099
+ sideEffects?.onError?.(err);
1100
+ throw transformedError;
1101
+ }
1102
+ }
1103
+ //# sourceMappingURL=events-v1-order-orders.universal.js.map