@wix/auto_sdk_events_orders 1.0.22 → 1.0.24
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.
- package/build/cjs/index.d.ts +17 -7
- package/build/cjs/index.js +2 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{events-v1-order-orders.universal-C56YAmFe.d.ts → index.typings.d.ts} +402 -1
- package/build/cjs/index.typings.js +2438 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +17 -7
- package/build/es/index.mjs +2 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/{events-v1-order-orders.universal-C56YAmFe.d.mts → index.typings.d.mts} +402 -1
- package/build/es/index.typings.mjs +2381 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +17 -7
- package/build/internal/cjs/index.js +2 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{events-v1-order-orders.universal-C56YAmFe.d.ts → index.typings.d.ts} +402 -1
- package/build/internal/cjs/index.typings.js +2438 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +17 -7
- package/build/internal/es/index.mjs +2 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{events-v1-order-orders.universal-C56YAmFe.d.mts → index.typings.d.mts} +402 -1
- package/build/internal/es/index.typings.mjs +2381 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +3 -3
package/build/internal/cjs/{events-v1-order-orders.universal-C56YAmFe.d.ts → index.typings.d.ts}
RENAMED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface Order {
|
|
2
4
|
/** Unique order number. */
|
|
3
5
|
orderNumber?: string;
|
|
@@ -182,6 +184,8 @@ declare enum SubdivisionType {
|
|
|
182
184
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
183
185
|
COUNTRY = "COUNTRY"
|
|
184
186
|
}
|
|
187
|
+
/** @enumType */
|
|
188
|
+
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
185
189
|
/** Subdivision Concordance values */
|
|
186
190
|
interface StandardDetails {
|
|
187
191
|
/**
|
|
@@ -618,6 +622,8 @@ declare enum ScheduledActionEnumAction {
|
|
|
618
622
|
/** Void after the delay. */
|
|
619
623
|
VOID = "VOID"
|
|
620
624
|
}
|
|
625
|
+
/** @enumType */
|
|
626
|
+
type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
|
|
621
627
|
declare enum Action {
|
|
622
628
|
/** Order can be archived. */
|
|
623
629
|
ARCHIVE = "ARCHIVE",
|
|
@@ -630,6 +636,8 @@ declare enum Action {
|
|
|
630
636
|
/** Order can be voided. */
|
|
631
637
|
VOID = "VOID"
|
|
632
638
|
}
|
|
639
|
+
/** @enumType */
|
|
640
|
+
type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
|
|
633
641
|
interface GiftCardPaymentDetails {
|
|
634
642
|
/**
|
|
635
643
|
* Gift card payment id.
|
|
@@ -2067,6 +2075,8 @@ interface OrderInitiated {
|
|
|
2067
2075
|
reservationId?: string;
|
|
2068
2076
|
/** Order was marked as paid. */
|
|
2069
2077
|
markedAsPaid?: boolean | null;
|
|
2078
|
+
/** Whether marketing consent was given. */
|
|
2079
|
+
marketingConsent?: boolean | null;
|
|
2070
2080
|
}
|
|
2071
2081
|
interface UpdateCheckoutRequest {
|
|
2072
2082
|
/**
|
|
@@ -2243,6 +2253,31 @@ interface QueryEventsWithPaidReservationsResponse {
|
|
|
2243
2253
|
*/
|
|
2244
2254
|
eventIds?: string[] | null;
|
|
2245
2255
|
}
|
|
2256
|
+
type UpdateOrderApplicationErrors = {
|
|
2257
|
+
code?: 'ORDER_ACTION_NOT_AVAILABLE';
|
|
2258
|
+
description?: string;
|
|
2259
|
+
data?: Record<string, any>;
|
|
2260
|
+
};
|
|
2261
|
+
type BulkUpdateOrdersApplicationErrors = {
|
|
2262
|
+
code?: 'ORDER_ACTION_NOT_AVAILABLE';
|
|
2263
|
+
description?: string;
|
|
2264
|
+
data?: Record<string, any>;
|
|
2265
|
+
};
|
|
2266
|
+
type ConfirmOrderApplicationErrors = {
|
|
2267
|
+
code?: 'ORDER_ACTION_NOT_AVAILABLE';
|
|
2268
|
+
description?: string;
|
|
2269
|
+
data?: Record<string, any>;
|
|
2270
|
+
};
|
|
2271
|
+
type CaptureAuthorizedPaymentApplicationErrors = {
|
|
2272
|
+
code?: 'ORDER_STATUS_NOT_AUTHORIZED';
|
|
2273
|
+
description?: string;
|
|
2274
|
+
data?: Record<string, any>;
|
|
2275
|
+
};
|
|
2276
|
+
type VoidAuthorizedPaymentApplicationErrors = {
|
|
2277
|
+
code?: 'ORDER_STATUS_NOT_AUTHORIZED';
|
|
2278
|
+
description?: string;
|
|
2279
|
+
data?: Record<string, any>;
|
|
2280
|
+
};
|
|
2246
2281
|
interface BaseEventMetadata {
|
|
2247
2282
|
/**
|
|
2248
2283
|
* App instance ID.
|
|
@@ -2261,26 +2296,142 @@ interface OrderDeletedEnvelope {
|
|
|
2261
2296
|
data: OrderDeleted;
|
|
2262
2297
|
metadata: BaseEventMetadata;
|
|
2263
2298
|
}
|
|
2299
|
+
/**
|
|
2300
|
+
* This event is triggered when an order is deleted via GDPR request.
|
|
2301
|
+
* @permissionScope Read Events - all read permissions
|
|
2302
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2303
|
+
* @permissionScope Manage Events - all permissions
|
|
2304
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2305
|
+
* @permissionScope Manage Events
|
|
2306
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2307
|
+
* @permissionScope Read Basic Events Order Info
|
|
2308
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2309
|
+
* @permissionScope Manage Orders
|
|
2310
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2311
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2312
|
+
* @webhook
|
|
2313
|
+
* @eventType wix.events.ticketing.events.OrderDeleted
|
|
2314
|
+
* @serviceIdentifier wix.events.ticketing.OrderManagement
|
|
2315
|
+
* @slug order_deleted
|
|
2316
|
+
*/
|
|
2317
|
+
declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise<void>): void;
|
|
2264
2318
|
interface OrderUpdatedEnvelope {
|
|
2265
2319
|
data: OrderUpdated;
|
|
2266
2320
|
metadata: BaseEventMetadata;
|
|
2267
2321
|
}
|
|
2322
|
+
/** @permissionScope Read Events - all read permissions
|
|
2323
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2324
|
+
* @permissionScope Manage Events - all permissions
|
|
2325
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2326
|
+
* @permissionScope Manage Events
|
|
2327
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2328
|
+
* @permissionScope Read Basic Events Order Info
|
|
2329
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2330
|
+
* @permissionScope Manage Orders
|
|
2331
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2332
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2333
|
+
* @webhook
|
|
2334
|
+
* @eventType wix.events.ticketing.events.OrderUpdated
|
|
2335
|
+
* @serviceIdentifier wix.events.ticketing.OrderManagement
|
|
2336
|
+
* @slug order_updated
|
|
2337
|
+
*/
|
|
2338
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2268
2339
|
interface OrderConfirmedEnvelope {
|
|
2269
2340
|
data: OrderConfirmed;
|
|
2270
2341
|
metadata: BaseEventMetadata;
|
|
2271
2342
|
}
|
|
2343
|
+
/** @permissionScope Read Events - all read permissions
|
|
2344
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2345
|
+
* @permissionScope Manage Events - all permissions
|
|
2346
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2347
|
+
* @permissionScope Manage Events
|
|
2348
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2349
|
+
* @permissionScope Read Basic Events Order Info
|
|
2350
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2351
|
+
* @permissionScope Manage Orders
|
|
2352
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2353
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2354
|
+
* @webhook
|
|
2355
|
+
* @eventType wix.events.ticketing.events.OrderConfirmed
|
|
2356
|
+
* @serviceIdentifier wix.events.ticketing.CheckoutService
|
|
2357
|
+
* @slug order_confirmed
|
|
2358
|
+
*/
|
|
2359
|
+
declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise<void>): void;
|
|
2272
2360
|
interface OrderInitiatedEnvelope {
|
|
2273
2361
|
data: OrderInitiated;
|
|
2274
2362
|
metadata: BaseEventMetadata;
|
|
2275
2363
|
}
|
|
2364
|
+
/** @permissionScope Read Events - all read permissions
|
|
2365
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2366
|
+
* @permissionScope Manage Events - all permissions
|
|
2367
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2368
|
+
* @permissionScope Manage Events
|
|
2369
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2370
|
+
* @permissionScope Read Basic Events Order Info
|
|
2371
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2372
|
+
* @permissionScope Manage Orders
|
|
2373
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2374
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2375
|
+
* @webhook
|
|
2376
|
+
* @eventType wix.events.ticketing.events.OrderInitiated
|
|
2377
|
+
* @serviceIdentifier wix.events.ticketing.CheckoutService
|
|
2378
|
+
* @slug order_initiated
|
|
2379
|
+
*/
|
|
2380
|
+
declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise<void>): void;
|
|
2276
2381
|
interface OrderReservationCreatedEnvelope {
|
|
2277
2382
|
data: ReservationCreated;
|
|
2278
2383
|
metadata: BaseEventMetadata;
|
|
2279
2384
|
}
|
|
2385
|
+
/** @permissionScope Read Events - all read permissions
|
|
2386
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2387
|
+
* @permissionScope Manage Events - all permissions
|
|
2388
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2389
|
+
* @permissionScope Manage Events
|
|
2390
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2391
|
+
* @permissionScope Read Basic Events Order Info
|
|
2392
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2393
|
+
* @permissionScope Manage Orders
|
|
2394
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2395
|
+
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2396
|
+
* @webhook
|
|
2397
|
+
* @eventType wix.events.ticketing.events.ReservationCreated
|
|
2398
|
+
* @serviceIdentifier wix.events.ticketing.CheckoutService
|
|
2399
|
+
* @slug reservation_created
|
|
2400
|
+
*/
|
|
2401
|
+
declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise<void>): void;
|
|
2280
2402
|
interface OrderReservationUpdatedEnvelope {
|
|
2281
2403
|
data: ReservationUpdated;
|
|
2282
2404
|
metadata: BaseEventMetadata;
|
|
2283
2405
|
}
|
|
2406
|
+
/** @permissionScope Read Events - all read permissions
|
|
2407
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2408
|
+
* @permissionScope Manage Events - all permissions
|
|
2409
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2410
|
+
* @permissionScope Manage Events
|
|
2411
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2412
|
+
* @permissionScope Read Basic Events Order Info
|
|
2413
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2414
|
+
* @permissionScope Manage Orders
|
|
2415
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2416
|
+
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2417
|
+
* @webhook
|
|
2418
|
+
* @eventType wix.events.ticketing.events.ReservationUpdated
|
|
2419
|
+
* @serviceIdentifier wix.events.ticketing.CheckoutService
|
|
2420
|
+
* @slug reservation_updated
|
|
2421
|
+
*/
|
|
2422
|
+
declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
|
|
2423
|
+
type OrderNonNullablePaths = `orderNumber` | `reservationId` | `snapshotId` | `eventId` | `contactId` | `memberId` | `firstName` | `lastName` | `email` | `checkoutForm.inputValues` | `checkoutForm.inputValues.${number}.inputName` | `checkoutForm.inputValues.${number}.value` | `confirmed` | `status` | `method` | `ticketsQuantity` | `totalPrice.amount` | `totalPrice.currency` | `ticketsPdf` | `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.qrCode` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.ticketPdf` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl` | `archived` | `anonymized` | `fullName` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `fullyCheckedIn` | `paymentDetails.transaction.transactionId` | `paymentDetails.transaction.method` | `channel`;
|
|
2424
|
+
/**
|
|
2425
|
+
* Retrieves a list of orders, including ticket data.
|
|
2426
|
+
* @public
|
|
2427
|
+
* @param options - An object representing the available options for retrieving a list of orders.
|
|
2428
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2429
|
+
* @applicableIdentity APP
|
|
2430
|
+
* @fqn wix.events.ticketing.OrderManagement.ListOrders
|
|
2431
|
+
*/
|
|
2432
|
+
declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
|
|
2433
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2434
|
+
}[OrderNonNullablePaths]>>;
|
|
2284
2435
|
interface ListOrdersOptions {
|
|
2285
2436
|
/** Offset. */
|
|
2286
2437
|
offset?: number;
|
|
@@ -2361,6 +2512,23 @@ interface ListOrdersOptions {
|
|
|
2361
2512
|
*/
|
|
2362
2513
|
contactId?: string[];
|
|
2363
2514
|
}
|
|
2515
|
+
/**
|
|
2516
|
+
* Retrieves an order, including ticket data.
|
|
2517
|
+
* <!--
|
|
2518
|
+
* >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.
|
|
2519
|
+
* -->
|
|
2520
|
+
* @public
|
|
2521
|
+
* @requiredField identifiers
|
|
2522
|
+
* @requiredField identifiers.eventId
|
|
2523
|
+
* @requiredField identifiers.orderNumber
|
|
2524
|
+
* @param options - An object representing the available options for getting an order.
|
|
2525
|
+
* @param identifiers - An object containing identifiers for the order to be retrieved.
|
|
2526
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2527
|
+
* @applicableIdentity APP
|
|
2528
|
+
* @returns Requested order.
|
|
2529
|
+
* @fqn wix.events.ticketing.OrderManagement.GetOrder
|
|
2530
|
+
*/
|
|
2531
|
+
declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
2364
2532
|
interface GetOrderIdentifiers {
|
|
2365
2533
|
/**
|
|
2366
2534
|
* Event ID to which the order belongs.
|
|
@@ -2386,6 +2554,23 @@ interface GetOrderOptions {
|
|
|
2386
2554
|
*/
|
|
2387
2555
|
fieldset?: OrderFieldsetWithLiterals[];
|
|
2388
2556
|
}
|
|
2557
|
+
/**
|
|
2558
|
+
* Updates an order.
|
|
2559
|
+
* @public
|
|
2560
|
+
* @requiredField identifiers
|
|
2561
|
+
* @requiredField identifiers.eventId
|
|
2562
|
+
* @requiredField identifiers.orderNumber
|
|
2563
|
+
* @param options - An object representing the available options for updating an order.
|
|
2564
|
+
* @param identifiers - An object containing identifiers for the order to be updated.
|
|
2565
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2566
|
+
* @applicableIdentity APP
|
|
2567
|
+
* @fqn wix.events.ticketing.OrderManagement.UpdateOrder
|
|
2568
|
+
*/
|
|
2569
|
+
declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
|
|
2570
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2571
|
+
}[OrderNonNullablePaths]> & {
|
|
2572
|
+
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
2573
|
+
}>;
|
|
2389
2574
|
interface UpdateOrderIdentifiers {
|
|
2390
2575
|
/**
|
|
2391
2576
|
* Event ID to which the order belongs.
|
|
@@ -2406,6 +2591,21 @@ interface UpdateOrderOptions {
|
|
|
2406
2591
|
/** Whether to archive the order. */
|
|
2407
2592
|
archived?: boolean;
|
|
2408
2593
|
}
|
|
2594
|
+
/**
|
|
2595
|
+
* Archives multiple orders.
|
|
2596
|
+
* @public
|
|
2597
|
+
* @requiredField eventId
|
|
2598
|
+
* @param options - An object representing the available options for confirming an order.
|
|
2599
|
+
* @param eventId - Event ID to which the order belongs.
|
|
2600
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2601
|
+
* @applicableIdentity APP
|
|
2602
|
+
* @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
|
|
2603
|
+
*/
|
|
2604
|
+
declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
|
|
2605
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2606
|
+
}[OrderNonNullablePaths]> & {
|
|
2607
|
+
__applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
|
|
2608
|
+
}>;
|
|
2409
2609
|
interface BulkUpdateOrdersOptions {
|
|
2410
2610
|
/**
|
|
2411
2611
|
* Unique order number.
|
|
@@ -2420,6 +2620,25 @@ interface BulkUpdateOrdersOptions {
|
|
|
2420
2620
|
/** Whether to archive the order. */
|
|
2421
2621
|
archived?: boolean;
|
|
2422
2622
|
}
|
|
2623
|
+
/**
|
|
2624
|
+
* Confirms an order.
|
|
2625
|
+
*
|
|
2626
|
+
*
|
|
2627
|
+
* This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
|
|
2628
|
+
* Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
|
|
2629
|
+
* @public
|
|
2630
|
+
* @requiredField eventId
|
|
2631
|
+
* @param options - An object representing the available options for confirming an order.
|
|
2632
|
+
* @param eventId - Event ID to which the order belongs.
|
|
2633
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2634
|
+
* @applicableIdentity APP
|
|
2635
|
+
* @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
|
|
2636
|
+
*/
|
|
2637
|
+
declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
|
|
2638
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2639
|
+
}[OrderNonNullablePaths]> & {
|
|
2640
|
+
__applicationErrorsType?: ConfirmOrderApplicationErrors;
|
|
2641
|
+
}>;
|
|
2423
2642
|
interface ConfirmOrderOptions {
|
|
2424
2643
|
/**
|
|
2425
2644
|
* Order numbers.
|
|
@@ -2429,6 +2648,18 @@ interface ConfirmOrderOptions {
|
|
|
2429
2648
|
*/
|
|
2430
2649
|
orderNumber?: string[];
|
|
2431
2650
|
}
|
|
2651
|
+
/**
|
|
2652
|
+
* Retrieves a summary of total ticket sales.
|
|
2653
|
+
* <!--
|
|
2654
|
+
* > 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.
|
|
2655
|
+
* -->
|
|
2656
|
+
* @public
|
|
2657
|
+
* @param options - An object representing the available options for retrieving a summary of total ticket sales.
|
|
2658
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2659
|
+
* @applicableIdentity APP
|
|
2660
|
+
* @fqn wix.events.ticketing.OrderManagement.GetSummary
|
|
2661
|
+
*/
|
|
2662
|
+
declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
|
|
2432
2663
|
interface GetSummaryOptions {
|
|
2433
2664
|
/**
|
|
2434
2665
|
* Event ID to which the order belongs.
|
|
@@ -2436,6 +2667,20 @@ interface GetSummaryOptions {
|
|
|
2436
2667
|
*/
|
|
2437
2668
|
eventId?: string | null;
|
|
2438
2669
|
}
|
|
2670
|
+
/**
|
|
2671
|
+
* Captures authorized payment asynchronously.
|
|
2672
|
+
* Eventually order will become paid.
|
|
2673
|
+
* For orders with non-authorized payments request will fail.
|
|
2674
|
+
* @param orderNumber - Order number.
|
|
2675
|
+
* @public
|
|
2676
|
+
* @requiredField orderNumber
|
|
2677
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2678
|
+
* @applicableIdentity APP
|
|
2679
|
+
* @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
|
|
2680
|
+
*/
|
|
2681
|
+
declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void & {
|
|
2682
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentApplicationErrors;
|
|
2683
|
+
}>;
|
|
2439
2684
|
interface CaptureAuthorizedPaymentOptions {
|
|
2440
2685
|
/**
|
|
2441
2686
|
* Event ID.
|
|
@@ -2443,6 +2688,20 @@ interface CaptureAuthorizedPaymentOptions {
|
|
|
2443
2688
|
*/
|
|
2444
2689
|
eventId?: string;
|
|
2445
2690
|
}
|
|
2691
|
+
/**
|
|
2692
|
+
* Voids authorized payment asynchronously.
|
|
2693
|
+
* Eventually order will become voided.
|
|
2694
|
+
* For orders with non-authorized payments request will fail.
|
|
2695
|
+
* @param orderNumber - Order number.
|
|
2696
|
+
* @public
|
|
2697
|
+
* @requiredField orderNumber
|
|
2698
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2699
|
+
* @applicableIdentity APP
|
|
2700
|
+
* @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
|
|
2701
|
+
*/
|
|
2702
|
+
declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void & {
|
|
2703
|
+
__applicationErrorsType?: VoidAuthorizedPaymentApplicationErrors;
|
|
2704
|
+
}>;
|
|
2446
2705
|
interface VoidAuthorizedPaymentOptions {
|
|
2447
2706
|
/**
|
|
2448
2707
|
* Event ID.
|
|
@@ -2450,6 +2709,28 @@ interface VoidAuthorizedPaymentOptions {
|
|
|
2450
2709
|
*/
|
|
2451
2710
|
eventId?: string;
|
|
2452
2711
|
}
|
|
2712
|
+
/**
|
|
2713
|
+
* Retrieves checkout details.
|
|
2714
|
+
* @public
|
|
2715
|
+
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2716
|
+
* @applicableIdentity APP
|
|
2717
|
+
* @applicableIdentity VISITOR
|
|
2718
|
+
* @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
|
|
2719
|
+
*/
|
|
2720
|
+
declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
|
|
2721
|
+
/**
|
|
2722
|
+
* Returns tickets available to reserve.
|
|
2723
|
+
* <!--
|
|
2724
|
+
* > 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.
|
|
2725
|
+
* -->
|
|
2726
|
+
* @public
|
|
2727
|
+
* @param options - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
2728
|
+
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2729
|
+
* @applicableIdentity APP
|
|
2730
|
+
* @applicableIdentity VISITOR
|
|
2731
|
+
* @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
|
|
2732
|
+
*/
|
|
2733
|
+
declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<NonNullablePaths<ListAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
|
|
2453
2734
|
interface ListAvailableTicketsOptions {
|
|
2454
2735
|
/**
|
|
2455
2736
|
* Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
|
|
@@ -2471,6 +2752,19 @@ interface ListAvailableTicketsOptions {
|
|
|
2471
2752
|
sort?: string;
|
|
2472
2753
|
state?: StateWithLiterals[];
|
|
2473
2754
|
}
|
|
2755
|
+
/**
|
|
2756
|
+
* Returns tickets available to reserve.
|
|
2757
|
+
* <!--
|
|
2758
|
+
* > 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.
|
|
2759
|
+
* -->
|
|
2760
|
+
* @public
|
|
2761
|
+
* @param options - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
2762
|
+
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2763
|
+
* @applicableIdentity APP
|
|
2764
|
+
* @applicableIdentity VISITOR
|
|
2765
|
+
* @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
|
|
2766
|
+
*/
|
|
2767
|
+
declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise<NonNullablePaths<QueryAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
|
|
2474
2768
|
interface QueryAvailableTicketsOptions {
|
|
2475
2769
|
/** Offset. */
|
|
2476
2770
|
offset?: number;
|
|
@@ -2493,6 +2787,22 @@ interface QueryAvailableTicketsOptions {
|
|
|
2493
2787
|
*/
|
|
2494
2788
|
sort?: string;
|
|
2495
2789
|
}
|
|
2790
|
+
/**
|
|
2791
|
+
* Reserves tickets for 20 minutes.
|
|
2792
|
+
*
|
|
2793
|
+
*
|
|
2794
|
+
* Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
|
|
2795
|
+
* When the reservation expires, the tickets are added back to the stock.
|
|
2796
|
+
* @public
|
|
2797
|
+
* @requiredField eventId
|
|
2798
|
+
* @param options - An object representing the available options for creating a reservation.
|
|
2799
|
+
* @param eventId - Event ID to which the reservation belongs.
|
|
2800
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2801
|
+
* @applicableIdentity APP
|
|
2802
|
+
* @applicableIdentity VISITOR
|
|
2803
|
+
* @fqn wix.events.ticketing.CheckoutService.CreateReservation
|
|
2804
|
+
*/
|
|
2805
|
+
declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<NonNullablePaths<CreateReservationResponse, `_id` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `reservationStatus`>>;
|
|
2496
2806
|
interface CreateReservationOptions {
|
|
2497
2807
|
/**
|
|
2498
2808
|
* Tickets to reserve.
|
|
@@ -2505,12 +2815,69 @@ interface CreateReservationOptions {
|
|
|
2505
2815
|
/** Whether to allow reservations for hidden tickets. */
|
|
2506
2816
|
allowHiddenTickets?: boolean;
|
|
2507
2817
|
}
|
|
2818
|
+
/**
|
|
2819
|
+
* Cancels ticket reservation and returns tickets to stock.
|
|
2820
|
+
* <!--
|
|
2821
|
+
* > 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.
|
|
2822
|
+
* -->
|
|
2823
|
+
* @param _id - Reservation ID.
|
|
2824
|
+
* @public
|
|
2825
|
+
* @requiredField _id
|
|
2826
|
+
* @requiredField eventId
|
|
2827
|
+
* @param identifiers - An object containing identifiers for the reservation to be cancelled.
|
|
2828
|
+
* @param eventId - Event ID to which the reservation belongs.
|
|
2829
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2830
|
+
* @applicableIdentity APP
|
|
2831
|
+
* @applicableIdentity VISITOR
|
|
2832
|
+
* @fqn wix.events.ticketing.CheckoutService.CancelReservation
|
|
2833
|
+
*/
|
|
2834
|
+
declare function cancelReservation(_id: string, eventId: string): Promise<void>;
|
|
2835
|
+
/**
|
|
2836
|
+
* Generates a preview of an invoice, including the given coupon or pricing plan.
|
|
2837
|
+
* @param reservationId - Reservation ID.
|
|
2838
|
+
* @public
|
|
2839
|
+
* @requiredField eventId
|
|
2840
|
+
* @requiredField reservationId
|
|
2841
|
+
* @param options - An object representing the available options for generating a preview of a reservation invoice.
|
|
2842
|
+
* @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
|
|
2843
|
+
* @param eventId - Event ID to which the invoice belongs.
|
|
2844
|
+
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2845
|
+
* @applicableIdentity APP
|
|
2846
|
+
* @applicableIdentity VISITOR
|
|
2847
|
+
* @fqn wix.events.ticketing.CheckoutService.GetInvoice
|
|
2848
|
+
*/
|
|
2849
|
+
declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise<NonNullablePaths<GetInvoiceResponse, `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `discountErrors.error` | `discountErrors.error.${number}.code` | `reservationStatus` | `reservationOccupied` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
|
|
2508
2850
|
interface GetInvoiceOptions {
|
|
2509
2851
|
/** Optional discount to be applied on the returned invoice. */
|
|
2510
2852
|
withDiscount?: DiscountRequest;
|
|
2511
2853
|
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
2512
2854
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
2513
2855
|
}
|
|
2856
|
+
/**
|
|
2857
|
+
* Checkouts the reserved tickets.
|
|
2858
|
+
*
|
|
2859
|
+
*
|
|
2860
|
+
* Creates an order and associates it with a site visitor contact.
|
|
2861
|
+
* Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
|
|
2862
|
+
*
|
|
2863
|
+
* 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.
|
|
2864
|
+
* 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:
|
|
2865
|
+
* `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
|
|
2866
|
+
*
|
|
2867
|
+
* Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
|
|
2868
|
+
* @public
|
|
2869
|
+
* @requiredField eventId
|
|
2870
|
+
* @requiredField options.guests.form
|
|
2871
|
+
* @param options - An object representing the available options for checking out a reserved ticket.
|
|
2872
|
+
* @param eventId - Event ID to which the checkout belongs.
|
|
2873
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2874
|
+
* @applicableIdentity APP
|
|
2875
|
+
* @applicableIdentity VISITOR
|
|
2876
|
+
* @fqn wix.events.ticketing.CheckoutService.Checkout
|
|
2877
|
+
*/
|
|
2878
|
+
declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
|
|
2879
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2880
|
+
}[OrderNonNullablePaths] | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
|
|
2514
2881
|
interface CheckoutOptionsForRequest {
|
|
2515
2882
|
/**
|
|
2516
2883
|
* Ticket reservation ID.
|
|
@@ -2536,6 +2903,26 @@ interface CheckoutOptionsForRequest {
|
|
|
2536
2903
|
/** Whether marketing consent was given */
|
|
2537
2904
|
marketingConsent?: boolean | null;
|
|
2538
2905
|
}
|
|
2906
|
+
/**
|
|
2907
|
+
* Updates order and tickets.
|
|
2908
|
+
*
|
|
2909
|
+
*
|
|
2910
|
+
* Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
|
|
2911
|
+
* @param orderNumber - Unique order number.
|
|
2912
|
+
* @public
|
|
2913
|
+
* @requiredField eventId
|
|
2914
|
+
* @requiredField orderNumber
|
|
2915
|
+
* @param options - An object representing the available options for updating an order and tickets.
|
|
2916
|
+
* @param identifiers - An object containing identifiers for the order and tickets to be updated.
|
|
2917
|
+
* @param eventId - Event ID to which the checkout belongs.
|
|
2918
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2919
|
+
* @applicableIdentity APP
|
|
2920
|
+
* @applicableIdentity VISITOR
|
|
2921
|
+
* @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
|
|
2922
|
+
*/
|
|
2923
|
+
declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
|
|
2924
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2925
|
+
}[OrderNonNullablePaths]>>;
|
|
2539
2926
|
interface UpdateCheckoutOptions {
|
|
2540
2927
|
/** Buyer details. */
|
|
2541
2928
|
buyer?: Buyer;
|
|
@@ -2556,6 +2943,20 @@ interface UpdateCheckoutOptions {
|
|
|
2556
2943
|
/** Benefit granted by the pricing plan. */
|
|
2557
2944
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
2558
2945
|
}
|
|
2946
|
+
/**
|
|
2947
|
+
* Creates order with payment details already initiated via Cashier Pay API.
|
|
2948
|
+
* @public
|
|
2949
|
+
* @documentationMaturity preview
|
|
2950
|
+
* @requiredField eventId
|
|
2951
|
+
* @requiredField options.reservationId
|
|
2952
|
+
* @param eventId - Event ID to which the checkout belongs.
|
|
2953
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2954
|
+
* @applicableIdentity APP
|
|
2955
|
+
* @fqn wix.events.ticketing.CheckoutService.PosCheckout
|
|
2956
|
+
*/
|
|
2957
|
+
declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
|
|
2958
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2959
|
+
}[OrderNonNullablePaths] | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
|
|
2559
2960
|
interface PosCheckoutOptions {
|
|
2560
2961
|
/**
|
|
2561
2962
|
* Ticket reservation ID.
|
|
@@ -2570,4 +2971,4 @@ interface PosCheckoutOptions {
|
|
|
2570
2971
|
paymentDetailsId?: string | null;
|
|
2571
2972
|
}
|
|
2572
2973
|
|
|
2573
|
-
export {
|
|
2974
|
+
export { Action, type ActionWithLiterals, type Address, type AddressLocation, type AddressStreetOneOf, type BalanceSummary, type BaseEventMetadata, type BulkUpdateOrdersApplicationErrors, type BulkUpdateOrdersOptions, type BulkUpdateOrdersRequest, type BulkUpdateOrdersResponse, type Buyer, type CalendarLinks, type CancelReservationRequest, type CancelReservationResponse, type CaptureAuthorizedPaymentApplicationErrors, type CaptureAuthorizedPaymentOptions, type CaptureAuthorizedPaymentRequest, type CaptureAuthorizedPaymentResponse, ChannelType, type ChannelTypeWithLiterals, type CheckIn, type CheckoutOptions, type CheckoutOptionsForRequest, type CheckoutRequest, type CheckoutResponse, type ConfirmOrderApplicationErrors, type ConfirmOrderOptions, type ConfirmOrderRequest, type ConfirmOrderResponse, type ConfirmReservationRequest, type ConfirmReservationResponse, type Counts, type CouponDiscount, type CreateReservationOptions, type CreateReservationRequest, type CreateReservationResponse, type Dashboard, type Discount, type DiscountErrors, type DiscountItem, type DiscountItemDiscountOneOf, type DiscountRequest, type Error, type EventKey, type ExpireReservationRequest, type ExpireReservationResponse, type FacetCounts, type Fee, FeeName, type FeeNameWithLiterals, FeeType, type FeeTypeWithLiterals, type FindOrderByReservationIdRequest, type FindOrderByReservationIdResponse, type FormResponse, type FormattedAddress, type GetCheckoutOptionsRequest, type GetCheckoutOptionsResponse, type GetInvoiceOptions, type GetInvoicePreviewRequest, type GetInvoiceRequest, type GetInvoiceResponse, type GetOrderIdentifiers, type GetOrderOptions, type GetOrderRequest, type GetOrderResponse, type GetPaymentInfoRequest, type GetPaymentInfoResponse, type GetReservationRequest, type GetReservationResponse, type GetSummaryOptions, type GetSummaryRequest, type GetSummaryResponse, type GiftCardErrors, type GiftCardErrorsError, type GiftCardPaymentDetails, type Guest, type GuestDetails, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type Invoice, type Item, type ListAvailableTicketsOptions, type ListAvailableTicketsRequest, type ListAvailableTicketsResponse, type ListOrdersOptions, type ListOrdersRequest, type ListOrdersResponse, type MessageEnvelope, type Money, type OnlineConferencingLogin, type Order, type OrderConfirmed, type OrderConfirmedEnvelope, type OrderDeleted, type OrderDeletedEnvelope, type OrderFacetCounts, type OrderFacets, OrderFieldset, type OrderFieldsetWithLiterals, type OrderInitiated, type OrderInitiatedEnvelope, type OrderPageUrls, type OrderPaid, type OrderReservationCreatedEnvelope, type OrderReservationUpdatedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderTag, type OrderTagWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdated, type OrderUpdatedEnvelope, type PaidPlanBenefit, type PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf, type PaymentDetails, type PaymentTransaction, type PaymentTransactionEvent, type PaymentTransactionSummary, type PercentDiscount, type PosCheckoutOptions, type PosCheckoutRequest, type PosCheckoutResponse, type PricingOption, type PricingOptions, type QueryAvailableTicketsOptions, type QueryAvailableTicketsRequest, type QueryAvailableTicketsResponse, type QueryEventsWithPaidReservationsRequest, type QueryEventsWithPaidReservationsResponse, type RawHttpResponse, type Reservation, type ReservationCount, type ReservationCreated, ReservationStatus, type ReservationStatusWithLiterals, type ReservationUpdated, type ResponseMetaData, ScheduledActionEnumAction, type ScheduledActionEnumActionWithLiterals, type StandardDetails, State, type StateWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Tax, TaxType, type TaxTypeWithLiterals, type Ticket, type TicketDefinition, TicketDefinitionFieldset, type TicketDefinitionFieldsetWithLiterals, type TicketDetails, type TicketPricing, type TicketPricingPriceOneOf, type TicketQuantity, type TicketReservation, type TicketReservationQuantity, type TicketSalePeriod, TicketSaleStatus, type TicketSaleStatusWithLiterals, type TicketSales, type TicketingTicket, Type, type TypeWithLiterals, type UpdateCheckoutOptions, type UpdateCheckoutRequest, type UpdateCheckoutResponse, type UpdateOrderApplicationErrors, type UpdateOrderIdentifiers, type UpdateOrderOptions, type UpdateOrderRequest, type UpdateOrderResponse, type VoidAuthorizedPaymentApplicationErrors, type VoidAuthorizedPaymentOptions, type VoidAuthorizedPaymentRequest, type VoidAuthorizedPaymentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixFeeConfig, bulkUpdateOrders, cancelReservation, captureAuthorizedPayment, checkout, confirmOrder, createReservation, getCheckoutOptions, getInvoice, getOrder, getSummary, listAvailableTickets, listOrders, onOrderConfirmed, onOrderDeleted, onOrderInitiated, onOrderReservationCreated, onOrderReservationUpdated, onOrderUpdated, posCheckout, queryAvailableTickets, updateCheckout, updateOrder, voidAuthorizedPayment };
|