@wix/auto_sdk_events_orders 1.0.16 → 1.0.17

package/build/cjs/src/events-v1-order-orders.types.d.ts

@@ -8,28 +8,28 @@ export interface Order {
     reservationId?: string;
     /**
      * Payment snapshot ID.
-     * Empty for FREE order.
+     * Empty if `status` of the order is `"FREE"`.
      * @format GUID
      * @readonly
      */
     snapshotId?: string;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
     /**
-     * Contact ID of buyer (resolved using email address).
+     * Contact ID of buyer, resolved using the email address provided. See the Contacts API for additional information.
      * @format GUID
      */
     contactId?: string;
     /**
-     * Member ID of buyer (if relevant).
+     * Buyer member ID, if applicable. See the Members API for additional information.
      * @format GUID
      */
     memberId?: string;
     /**
-     * RSVP created timestamp.
+     * Date and time the RSVP was created.
      * @readonly
      */
     created?: Date | null;
@@ -44,17 +44,17 @@ export interface Order {
     email?: string;
     /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
     checkoutForm?: FormResponse;
-    /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
+    /** Whether the order is confirmed. Triggered once the payment gateway processes the payment and funds reach the merchant's account. */
     confirmed?: boolean;
     /** Order status. */
     status?: OrderStatusWithLiterals;
     /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
     method?: string;
-    /** Tickets ordered. */
+    /** Amount of tickets ordered. */
     ticketsQuantity?: number;
     /** Total order price. */
     totalPrice?: Money;
-    /** URL to ticket PDF. */
+    /** Ticket PDF URL. */
     ticketsPdf?: string;
     /** Tickets (generated after payment). */
     tickets?: TicketingTicket[];
@@ -66,18 +66,18 @@ export interface Order {
     fullName?: string;
     /** Order invoice. */
     invoice?: Invoice;
-    /** Whether all tickets in order are checked-in. */
+    /** Whether all tickets in an order are checked-in. */
     fullyCheckedIn?: boolean;
     /** Internal order payment details */
     paymentDetails?: PaymentDetails;
-    /** Checkout channel type */
+    /** Checkout channel type. */
     channel?: ChannelTypeWithLiterals;
     /**
-     * Order updated timestamp.
+     * Date and time the order was updated.
      * @readonly
      */
     updated?: Date | null;
-    /** Whether marketing consent was given */
+    /** Whether marketing consent was given. */
     marketingConsent?: boolean | null;
 }
 export interface FormResponse {
@@ -99,7 +99,7 @@ export interface InputValue {
      */
     value?: string;
     /**
-     * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
+     * Multiple input values. For example, the array is filled if several checkboxes are ticked.
      * @maxSize 100
      * @maxLength 5000
      */
@@ -185,17 +185,17 @@ export interface StandardDetails {
     iso31662?: string | null;
 }
 export declare enum OrderStatus {
-    /** Order status not available for this request fieldset. */
+    /** Order status is not available for this request fieldset. */
     NA_ORDER_STATUS = "NA_ORDER_STATUS",
-    /** Order is confirmed and payment isn't required. */
+    /** Order is confirmed, no payment is required. */
     FREE = "FREE",
-    /** Order is paid for but the payment gateway has suspended the payment. */
+    /** Order was paid, but the payment gateway suspended the payment. */
     PENDING = "PENDING",
-    /** Order is paid via a payment gateway. */
+    /** Order is paid. */
     PAID = "PAID",
-    /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
+    /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
     OFFLINE_PENDING = "OFFLINE_PENDING",
-    /** Order is awaiting payment at the cashier. */
+    /** Order is awaiting for payment at the cashier. */
     INITIATED = "INITIATED",
     /** Order is canceled. */
     CANCELED = "CANCELED",
@@ -218,7 +218,7 @@ export interface Money {
      */
     amount?: string;
     /**
-     * ISO 4217 format of the currency e.g., `USD`.
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * @format CURRENCY
      */
     currency?: string;
@@ -234,7 +234,7 @@ export interface TicketingTicket {
     /** Associated order number. */
     orderNumber?: string;
     /**
-     * Ticket definition ID.
+     * Ticket definition ID. See the Ticket Definition API for additional information.
      * @format GUID
      */
     ticketDefinitionId?: string;
@@ -243,14 +243,14 @@ export interface TicketingTicket {
     /** Ticket price. */
     price?: Money;
     /**
-     * Whether ticket requires payment.
+     * Whether the ticket requires payment.
      * @readonly
      */
     free?: boolean;
-    /** Ticket policy (as displayed in PDF). */
+    /** Event and ticket policies. */
     policy?: string;
     /**
-     * Deprecated, use `check_in_url`.
+     * *Deprecated:** Use `tickets.checkInUrl` instead.
      * @deprecated
      */
     qrCode?: string;
@@ -258,7 +258,10 @@ export interface TicketingTicket {
     checkIn?: CheckIn;
     /** Associated order status. */
     orderStatus?: OrderStatusWithLiterals;
-    /** Whether order and ticket are visible in order list. */
+    /**
+     * Whether the order and ticket are archived.
+     * If set to `true`, they are not visible in the order list.
+     */
     orderArchived?: boolean;
     /** Buyer full name. */
     orderFullName?: string;
@@ -269,7 +272,7 @@ export interface TicketingTicket {
     /** Whether ticket is visible in guest list. */
     archived?: boolean;
     /**
-     * Deprecated, use `ticket_pdf_url`.
+     * *Deprecated:** Use `tickets.ticketPdfUrl` instead.
      * @deprecated
      */
     ticketPdf?: string;
@@ -285,17 +288,18 @@ export interface TicketingTicket {
     anonymized?: boolean;
     /**
      * Ticket check-in URL.
-     * Shown as QR code image in PDF.
-     * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
-     * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
+     *
+     * Shown as QR code image in PDF.  <br/>
+     * Format: `"https://www.wixevents.com/check-in/{ticket number},{event id}"`  <br/>
+     * Example: `"https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000"`
      */
     checkInUrl?: string;
     /** URL for ticket PDF download. */
     ticketPdfUrl?: string;
-    /** Associated order checkout channel type */
+    /** Associated order checkout channel type. */
     channel?: ChannelTypeWithLiterals;
     /**
-     * URL to download ticket in .pkpass format for Apple Wallet
+     * URL to download ticket in `.pkpass` format for Apple Wallet.
      * @format WEB_URL
      * @readonly
      */
@@ -307,7 +311,7 @@ export interface TicketingTicket {
     canceled?: boolean | null;
 }
 export interface CheckIn {
-    /** Time of check-in */
+    /** Time of check-in. */
     created?: Date | null;
 }
 export interface GuestDetails {
@@ -336,7 +340,7 @@ export interface GuestDetails {
     phone?: string | null;
 }
 export declare enum ChannelType {
-    /** Buyer created the order via an online channel such as a website or mobile app. */
+    /** Buyer created the order via an online channel, such as a website or a mobile app. */
     ONLINE = "ONLINE",
     /** Sales person created the order and collected the money. */
     OFFLINE_POS = "OFFLINE_POS"
@@ -345,13 +349,13 @@ export declare enum ChannelType {
 export type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
 export interface TicketDetails {
     /**
-     * Unique seat id in the event venue.
+     * Unique seat ID in the event venue.
      * @minLength 1
      * @maxLength 36
      */
     seatId?: string | null;
     /**
-     * Optional sector label.
+     * Section label.
      * @readonly
      */
     sectionLabel?: string | null;
@@ -376,18 +380,20 @@ export interface TicketDetails {
      */
     seatLabel?: string | null;
     /**
-     * Number of places in the spot. If not provided - defaults to 1.
+     * Number of places in the spot.
+     *
+     * Default: `1`.
      * @min 1
      * @max 50
      */
     capacity?: number | null;
     /**
-     * Custom pricing of ticket.
+     * Custom price of a ticket.
      * @format DECIMAL_VALUE
      */
     priceOverride?: string | null;
     /**
-     * Pricing option id.
+     * Pricing option ID.
      * @format GUID
      */
     pricingOptionId?: string | null;
@@ -404,14 +410,14 @@ export interface Invoice {
      * @deprecated
      */
     total?: Money;
-    /** Discount applied to cart. */
+    /** Discount applied to a cart. */
     discount?: Discount;
-    /** Tax applied to cart. */
+    /** Tax applied to a cart. */
     tax?: Tax;
     /** Total cart amount before discount, tax, and fees. */
     subTotal?: Money;
     /**
-     * Total amount of cart after discount, tax, and fees.
+     * Total amount of a cart after discount, tax, and fees.
      * Grand total is calculated in the following order:
      * 1. Total prices of all items in the cart are calculated.
      * 2. Discount is subtracted from the cart (if applicable).
@@ -426,7 +432,7 @@ export interface Invoice {
     fees?: Fee[];
     /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
     revenue?: Money;
-    /** URL to invoice preview. Returned only if order is paid. */
+    /** Invoice preview URL. Only returned if the order is paid. */
     previewUrl?: string | null;
 }
 export interface Item {
@@ -460,7 +466,7 @@ export interface Item {
 export interface Discount {
     /** Total discount amount. */
     amount?: Money;
-    /** Total charge after applied discount. */
+    /** Total sum after the discount. */
     afterDiscount?: Money;
     /**
      * Discount coupon code.
@@ -496,11 +502,11 @@ export interface DiscountItemDiscountOneOf {
     paidPlan?: PaidPlanDiscount;
 }
 export interface CouponDiscount {
-    /** Discount coupon name. */
+    /** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
     name?: string;
-    /** Discount coupon code. */
+    /** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
     code?: string;
-    /** Discount coupon ID. */
+    /** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
     couponId?: string;
 }
 export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
@@ -574,7 +580,7 @@ export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
 export declare enum FeeType {
     /** Fee is added to the ticket price at checkout. */
     FEE_ADDED = "FEE_ADDED",
-    /** Seller absorbs the fee. It is deducted from the ticket price. */
+    /** Seller absorbs the fee. It's deducted from the ticket price. */
     FEE_INCLUDED = "FEE_INCLUDED",
     /** Fee is added to the ticket price at checkout. */
     FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
@@ -587,7 +593,7 @@ export interface PaymentDetails {
 }
 export interface PaymentTransaction {
     /**
-     * Wix Payments transaction id
+     * Wix Payments transaction ID.
      * @format GUID
      * @readonly
      */
@@ -647,38 +653,39 @@ export interface BalanceSummary {
     /** Amount left to pay. */
     balance?: Money;
 }
+/** Triggered when an order is deleted. */
 export interface OrderDeleted {
-    /** Order deleted timestamp in ISO UTC format. */
+    /** Date and time the order was deleted. */
     timestamp?: Date | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
-    /** Contact ID associated with this order */
+    /** Contact ID associated with the order. */
     contactId?: string;
     /**
-     * Member ID associated with this order.
+     * Member ID associated with the order.
      * @format GUID
      */
     memberId?: string | null;
     /**
-     * Order created timestamp.
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
     /**
-     * Order updated timestamp.
+     * Date and time the order was updated.
      * @readonly
      */
     updated?: Date | null;
-    /** Whether order was anonymized by GDPR delete. */
+    /** Whether the order was anonymized by GDPR delete. */
     anonymized?: boolean;
     /** Order type. */
     orderType?: OrderTypeWithLiterals;
-    /** Whether event was triggered by GDPR delete request. */
+    /** Whether the event was triggered by GDPR delete request. */
     triggeredByAnonymizeRequest?: boolean;
     /** Tickets generated after payment. */
     tickets?: Ticket[];
@@ -761,7 +768,7 @@ export interface ListOrdersRequest {
      */
     limit?: number;
     /**
-     * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
+     * Which fields to return.
      * @maxSize 20
      */
     fieldset?: OrderFieldsetWithLiterals[];
@@ -819,13 +826,17 @@ export interface ListOrdersRequest {
     contactId?: string[];
 }
 export declare enum OrderFieldset {
-    /** Include tickets in response. */
+    /** Returns `tickets`. */
     TICKETS = "TICKETS",
-    /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
+    /**
+     * Returns `archived`, `confirmed`, `created`, `firstName`, `fullName`,
+     * `lastName`, `method`, `reservationId`, `snapshotId`,
+     * `status`, `ticketsPdf`, `ticketsQuantity`, `totalPrice`.
+     */
     DETAILS = "DETAILS",
-    /** Include `checkoutForm` in the response. */
+    /** Returns `checkoutForm`. */
     FORM = "FORM",
-    /** Include `invoice` in the response. */
+    /** Returns `invoice`. */
     INVOICE = "INVOICE"
 }
 /** @enumType */
@@ -887,7 +898,7 @@ export interface Counts {
 }
 export interface GetOrderRequest {
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId: string;
@@ -897,7 +908,7 @@ export interface GetOrderRequest {
      */
     orderNumber: string;
     /**
-     * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
+     * Which fields to return.
      * @maxSize 20
      */
     fieldset?: OrderFieldsetWithLiterals[];
@@ -916,7 +927,7 @@ export interface CalendarLinks {
 }
 export interface UpdateOrderRequest {
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId: string;
@@ -929,47 +940,48 @@ export interface UpdateOrderRequest {
     fields?: string[];
     /** Checkout form. */
     checkoutForm?: FormResponse;
-    /** Whether order is archived. */
+    /** Whether to archive the order. */
     archived?: boolean;
 }
 export interface UpdateOrderResponse {
     /** Updated order. */
     order?: Order;
 }
+/** Triggered when an order is updated. */
 export interface OrderUpdated {
-    /** Order updated timestamp in ISO UTC format. */
+    /** Date and time the order was updated. */
     timestamp?: Date | null;
     /**
-     * Site language when Order initiated
+     * Site language when the order was initiated.
      * @format LANGUAGE
      */
     language?: string | null;
     /**
-     * Locale in which Order was created.
+     * Locale in which the order was created.
      * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
-    /** Contact ID associated with this order. */
+    /** Contact ID associated with the order. */
     contactId?: string;
     /**
-     * Member ID associated with this order.
+     * Member ID associated with the order.
      * @format GUID
      */
     memberId?: string | null;
     /**
-     * Order created timestamp.
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
     /**
-     * Order updated timestamp.
+     * Date and time the order was updated.
      * @readonly
      */
     updated?: Date | null;
@@ -996,11 +1008,12 @@ export interface OrderUpdated {
 }
 export interface BulkUpdateOrdersRequest {
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId: string;
     /**
+     * Unique order number.
      * @minLength 1
      * @maxLength 36
      * @minSize 1
@@ -1018,7 +1031,7 @@ export interface BulkUpdateOrdersResponse {
 }
 export interface ConfirmOrderRequest {
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId: string;
@@ -1036,7 +1049,7 @@ export interface ConfirmOrderResponse {
 }
 export interface GetSummaryRequest {
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string | null;
@@ -1093,22 +1106,22 @@ export interface GetPaymentInfoResponse {
 }
 export interface PaymentTransactionSummary {
     /**
-     * Wix Payments transaction id
+     * Wix Payments transaction ID.
      * @format GUID
      * @readonly
      */
     transactionId?: string;
     /**
-     * Final transaction status
+     * Final transaction status.
      * @readonly
      */
     finalTransactionStatus?: string;
-    /** Transaction events */
+    /** Transaction events. */
     events?: PaymentTransactionEvent[];
 }
 export interface PaymentTransactionEvent {
     /**
-     * Order snapshot id
+     * Order snapshot ID.
      * @format GUID
      * @readonly
      */
@@ -1174,6 +1187,22 @@ export interface VoidAuthorizedPaymentRequest {
 }
 export interface VoidAuthorizedPaymentResponse {
 }
+export interface FindOrderByReservationIdRequest {
+    /**
+     * Event ID
+     * @format GUID
+     */
+    eventId?: string;
+    /**
+     * Reservation ID.
+     * @format GUID
+     */
+    reservationId?: string;
+}
+export interface FindOrderByReservationIdResponse {
+    /** Order. */
+    order?: Order;
+}
 export interface MessageEnvelope {
     /**
      * App instance ID.
@@ -1246,37 +1275,38 @@ export declare enum WebhookIdentityType {
 }
 /** @enumType */
 export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** Triggered when an order is confirmed. */
 export interface OrderConfirmed {
-    /** Order confirmation timestamp in ISO UTC. */
+    /** Date and time the order was confirmed. */
     timestamp?: Date | null;
     /**
-     * Site language when Order initiated
+     * Site language when the order was initiated.
      * @format LANGUAGE
      */
     language?: string | null;
     /** Notifications silenced for this domain event. */
     silent?: boolean | null;
     /**
-     * Locale in which Order was created.
+     * Locale in which the order was created.
      * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
-    /** Contact ID associated with this order. */
+    /** Contact ID associated with the order. */
     contactId?: string;
     /**
-     * Member ID associated with this order.
+     * Member ID associated with the order.
      * @format GUID
      */
     memberId?: string | null;
     /**
-     * Order created timestamp
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
@@ -1296,26 +1326,27 @@ export interface OrderConfirmed {
     tickets?: Ticket[];
     /** Invoice. */
     invoice?: Invoice;
-    /** Reservation ID associated with this order. */
+    /** Reservation ID associated with the order. */
     reservationId?: string;
 }
+/** Triggered when an order is paid. */
 export interface OrderPaid {
-    /** Order paid timestamp in ISO UTC. */
+    /** Date and time the order was paid. */
     timestamp?: Date | null;
     /**
-     * Site language when Order initiated
+     * Site language when the order was initiated.
      * @format LANGUAGE
      */
     language?: string | null;
     /** Notifications silenced for this domain event. */
     silent?: boolean | null;
     /**
-     * Locale in which Order was created.
+     * Locale in which the order was created.
      * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
@@ -1334,7 +1365,7 @@ export interface OrderPaid {
      */
     memberId?: string | null;
     /**
-     * Order created timestamp
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
@@ -1370,11 +1401,12 @@ export interface OrderPaid {
     /** Invoice. */
     invoice?: Invoice;
 }
+/** Triggered when a reservation is created. */
 export interface ReservationCreated {
-    /** Reservation created timestamp in ISO UTC format. */
+    /** Date and time the reservation was created. */
     timestamp?: Date | null;
     /**
-     * Event ID.
+     * Event ID to which the reservation belongs.
      * @format GUID
      */
     eventId?: string;
@@ -1384,33 +1416,33 @@ export interface ReservationCreated {
      * @format GUID
      */
     reservationId?: string;
-    /** Reservation expiration timestamp. */
+    /** Date and time the reservation expires. */
     expires?: Date | null;
     /** Reservation status. */
     status?: ReservationStatusWithLiterals;
     /**
-     * Reservation ticket quantities.
+     * Amount of tickets in the reservation.
      * @maxSize 50
      */
     quantities?: TicketQuantity[];
-    /** Reservation update timestamp. */
+    /** Date and time the reservation was updated. */
     updatedDate?: Date | null;
     /**
-     * Reservation counts.
+     * Number of reservations.
      * @maxSize 50
      */
     counts?: ReservationCount[];
 }
 export declare enum ReservationStatus {
-    /** The Reservation is pending confirmation and will expire after the expiration due time. */
+    /** The Reservation is pending confirmation. It will expire after a certain amount of time. */
     RESERVATION_PENDING = "RESERVATION_PENDING",
     /** The reservation is confirmed and will not expire. */
     RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
-    /** The reservation is canceled because of non payment. */
+    /** The reservation is canceled because it's not paid. */
     RESERVATION_CANCELED = "RESERVATION_CANCELED",
     /** The reservation is canceled manually by the buyer. */
     RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
-    /** The reservation is expired. */
+    /** The reservation has expired. */
     RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
 }
 /** @enumType */
@@ -1441,11 +1473,12 @@ export interface ReservationCount {
     /** True if paid ticket reservation exist. */
     paidExists?: boolean;
 }
+/** Triggered when a reservation is updated. */
 export interface ReservationUpdated {
-    /** Reservation updated timestamp. */
+    /** Date and time the reservation was updated. */
     timestamp?: Date | null;
     /**
-     * Event ID.
+     * Event ID to which the reservation belongs.
      * @format GUID
      */
     eventId?: string;
@@ -1457,17 +1490,17 @@ export interface ReservationUpdated {
     reservationId?: string;
     /** Reservation status. */
     status?: ReservationStatusWithLiterals;
-    /** Reservation expiration timestamp. */
+    /** Date and time the reservation expires. */
     expires?: Date | null;
     /**
-     * Reservation ticket quantities.
+     * Amount of tickets in the reservation.
      * @maxSize 50
      */
     quantities?: TicketQuantity[];
-    /** Reservation update timestamp. */
+    /** Date and time the reservation was updated. */
     updatedDate?: Date | null;
     /**
-     * Reservation counts.
+     * Number of reservations.
      * @maxSize 50
      */
     counts?: ReservationCount[];
@@ -1479,7 +1512,7 @@ export interface GetCheckoutOptionsResponse {
     paymentMethodConfigured?: boolean;
     /** Whether coupons are accepted at checkout. */
     acceptCoupons?: boolean;
-    /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */
+    /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature `"events_sell_tickets"`. */
     premiumServices?: boolean;
     /** Whether there are any paid tickets available for sale. */
     paidTickets?: boolean;
@@ -1488,7 +1521,7 @@ export interface GetCheckoutOptionsResponse {
 }
 export interface ListAvailableTicketsRequest {
     /**
-     * Event ID. If not provided, available tickets for all events in the site will be returned.
+     * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
      * @format GUID
      */
     eventId?: string;
@@ -1500,8 +1533,9 @@ export interface ListAvailableTicketsRequest {
      */
     limit?: number;
     /**
-     * Sort order, defaults to "created:asc".
-     * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
+     * Sort order.
+     *
+     * Default: `created:asc`.
      * @maxLength 100
      */
     sort?: string;
@@ -1670,16 +1704,17 @@ export interface QueryAvailableTicketsRequest {
      * @max 1000
      */
     limit?: number;
+    /** Ticket definition. */
+    filter?: Record<string, any> | null;
     /**
-     * Ticket definition.
-     * See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
+     * Which fields to return.
+     * @maxSize 20
      */
-    filter?: Record<string, any> | null;
-    /** @maxSize 20 */
     fieldset?: TicketDefinitionFieldsetWithLiterals[];
     /**
-     * Sort order, defaults to "created:asc".
-     * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
+     * Sort order.
+     *
+     * Default: `"created:asc"`.
      * @maxLength 100
      */
     sort?: string;
@@ -1700,7 +1735,7 @@ export interface QueryAvailableTicketsResponse {
 }
 export interface CreateReservationRequest {
     /**
-     * Event ID.
+     * Event ID to which the reservation belongs.
      * @format GUID
      */
     eventId: string;
@@ -1710,9 +1745,9 @@ export interface CreateReservationRequest {
      * @maxSize 50
      */
     ticketQuantities?: TicketReservationQuantity[];
-    /** Whether to ignore the available ticket limits upon reservation. */
+    /** Whether to ignore the available ticket limits upon a reservation. */
     ignoreLimits?: boolean;
-    /** Whether to allow reservation for hidden tickets. */
+    /** Whether to allow reservations for hidden tickets. */
     allowHiddenTickets?: boolean;
 }
 export interface TicketReservationQuantity {
@@ -1742,7 +1777,7 @@ export interface CreateReservationResponse {
      * @format GUID
      */
     id?: string;
-    /** Reservation expiration timestamp. */
+    /** Date and time the reservation expires. */
     expires?: Date | null;
     /** Ticket reservations. */
     reservations?: TicketReservation[];
@@ -1753,7 +1788,7 @@ export interface CreateReservationResponse {
 }
 export interface TicketReservation {
     /**
-     * Quantity of reserved tickets.
+     * Amount of reserved tickets.
      * @min 1
      * @max 20
      */
@@ -1764,7 +1799,7 @@ export interface TicketReservation {
 }
 export interface CancelReservationRequest {
     /**
-     * Event ID.
+     * Event ID to which the reservation belongs.
      * @format GUID
      */
     eventId: string;
@@ -1778,7 +1813,7 @@ export interface CancelReservationResponse {
 }
 export interface GetInvoiceRequest {
     /**
-     * Event ID.
+     * Event ID to which the invoice belongs.
      * @format GUID
      */
     eventId: string;
@@ -1820,7 +1855,7 @@ export interface GetInvoiceResponse {
     expires?: Date | null;
     /** Reservation status. */
     reservationStatus?: ReservationStatusWithLiterals;
-    /** Whether this reservation is already used in checkout. */
+    /** Whether this reservation is already used in a checkout. */
     reservationOccupied?: boolean;
     /** Ticket reservations. */
     reservations?: TicketReservation[];
@@ -1899,7 +1934,7 @@ export interface Guest {
     form?: FormResponse;
 }
 export interface CheckoutOptions {
-    /** Whether to ignore settings to notify contacts or users. */
+    /** Whether to ignore settings to notify contacts. */
     silent?: boolean;
     /** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */
     payInPerson?: boolean;
@@ -1915,43 +1950,44 @@ export interface CheckoutResponse {
     expires?: Date | null;
     /** Ticket reservations. */
     reservations?: TicketReservation[];
-    /** Order page url. */
+    /** Order page URL. */
     orderPageUrl?: string | null;
 }
+/** Triggered when an order is initiated. */
 export interface OrderInitiated {
-    /** Order initiated timestamp in ISO UTC format. */
+    /** Date and time the order was initiated. */
     timestamp?: Date | null;
     /**
-     * Site language when Order initiated
+     * Site language when the order was initiated.
      * @format LANGUAGE
      */
     language?: string | null;
     /**
-     * Locale in which Order was created.
+     * Locale in which the order was created.
      * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
-    /** Contact ID associated with this order. */
+    /** Contact ID associated with the order. */
     contactId?: string;
     /**
-     * Member ID associated with this order.
+     * Member ID associated with the order.
      * @format GUID
      */
     memberId?: string | null;
     /**
-     * Order created timestamp.
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
     /**
-     * Order updated timestamp.
+     * Date and time the order was updated.
      * @readonly
      */
     updated?: Date | null;
@@ -1967,14 +2003,14 @@ export interface OrderInitiated {
     status?: OrderStatusWithLiterals;
     /** Invoice. */
     invoice?: Invoice;
-    /** Reservation ID associated with this order. */
+    /** Reservation ID associated with the order. */
     reservationId?: string;
     /** Order was marked as paid. */
     markedAsPaid?: boolean | null;
 }
 export interface UpdateCheckoutRequest {
     /**
-     * Event ID.
+     * Event ID to which the checkout belongs.
      * @format GUID
      */
     eventId: string;
@@ -1991,7 +2027,11 @@ export interface UpdateCheckoutRequest {
      * @maxSize 20
      */
     guests?: Guest[];
-    /** Member ID (if empty - no site member is associated to this order). */
+    /**
+     * Member ID.
+     *
+     * If empty, no site member is associated to this order.
+     */
     memberId?: string | null;
     /** Discount to apply on the invoice. */
     discount?: DiscountRequest;
@@ -2001,27 +2041,27 @@ export interface UpdateCheckoutRequest {
 export interface UpdateCheckoutResponse {
     /** Updated order. */
     order?: Order;
-    /** Order page url. */
+    /** Order page URL. */
     orderPageUrl?: string | null;
 }
 export interface OrderPageUrls {
     /**
-     * Success order page url.
+     * Success order page URL.
      * @format WEB_URL
      */
     success?: string | null;
     /**
-     * Pending order page url.
+     * Pending order page URL.
      * @format WEB_URL
      */
     pending?: string | null;
     /**
-     * Canceled order page url.
+     * Canceled order page URL.
      * @format WEB_URL
      */
     canceled?: string | null;
     /**
-     * Error order page url.
+     * Error order page URL.
      * @format WEB_URL
      */
     error?: string | null;
@@ -2065,14 +2105,81 @@ export interface GetReservationRequest {
     reservationId?: string | null;
 }
 export interface GetReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface Reservation {
     /** Date and time the Ticket Reservation was created. */
     createdDate?: Date | null;
     /** Date and time the Ticket Reservation was last updated. */
     updatedDate?: Date | null;
-    /** Date and time the Pending TicketReservation will expire. */
+    /** Date and time the pending ticket reservation will expire. */
     expirationDate?: Date | null;
     /** Reservation status. */
     reservationStatus?: ReservationStatusWithLiterals;
-    /** Ticket reservations. */
+    /**
+     * Ticket reservations.
+     * @maxSize 50
+     */
     reservations?: TicketReservation[];
 }
+export interface ConfirmReservationRequest {
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId?: string | null;
+    /**
+     * Ticket reservation ID.
+     * @format GUID
+     */
+    reservationId?: string | null;
+}
+export interface ConfirmReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface ExpireReservationRequest {
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId?: string | null;
+    /**
+     * Ticket reservation ID.
+     * @format GUID
+     */
+    reservationId?: string | null;
+}
+export interface ExpireReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface QueryEventsWithPaidReservationsRequest {
+    /**
+     * Event Keys.
+     * @minSize 1
+     * @maxSize 100
+     */
+    eventKeys?: EventKey[];
+}
+export interface EventKey {
+    /**
+     * Instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId?: string | null;
+}
+export interface QueryEventsWithPaidReservationsResponse {
+    /**
+     * Event IDs.
+     * @format GUID
+     * @maxSize 100
+     */
+    eventIds?: string[] | null;
+}