@wix/auto_sdk_events_orders 1.0.16 → 1.0.18

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