@wix/auto_sdk_events_orders 1.0.17 → 1.0.19

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