@wix/events 1.0.165 → 1.0.166

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

@@ -5,16 +5,15 @@ export interface Order {
     /** Reservation ID. */
     reservationId?: string;
     /**
-     * Payment snapshot ID.
-     * Empty for FREE order.
+     * Payment snapshot ID. Empty for the `FREE` order.
      * @readonly
      */
     snapshotId?: string;
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string;
     /** Contact ID of buyer (resolved using email address). */
     contactId?: string;
-    /** Member ID of buyer (if relevant). */
+    /** Buyer member ID, if applicable. */
     memberId?: string;
     /**
      * RSVP created timestamp.
@@ -31,15 +30,24 @@ export interface Order {
     checkoutForm?: FormResponse;
     /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
     confirmed?: boolean;
-    /** Order status. */
+    /**
+     * Order status. Possible values:
+     * - `FREE`: The order is confirmed, no payment is required.
+     * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
+     * - `PAID`: The order is paid.
+     * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
+     * - `INITIATED`: The order is awaiting for payment.
+     * - `CANCELED`: The order is canceled.
+     * - `DECLINED`: The order is payment is declined.
+     */
     status?: OrderStatus;
     /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
     method?: string;
-    /** Tickets ordered. */
+    /** Quantity of ordered tickets. */
     ticketsQuantity?: number;
     /** Total order price. */
     totalPrice?: Money;
-    /** URL to ticket PDF. */
+    /** Ticket PDF URL. */
     ticketsPdf?: string;
     /** Tickets (generated after payment). */
     tickets?: TicketingTicket[];
@@ -64,11 +72,15 @@ export interface Order {
     updated?: Date;
 }
 export interface FormResponse {
+    /** Input fields for a checkout form. */
     inputValues?: InputValue[];
 }
 export interface InputValue {
+    /** Input field name. */
     inputName?: string;
+    /** Input field value. */
     value?: string;
+    /** Multiple input field values. */
     values?: string[];
 }
 export interface FormattedAddress {
@@ -155,7 +167,7 @@ export declare enum OrderStatus {
 export interface Money {
     /** *Deprecated:** Use `value` instead. */
     amount?: string;
-    /** ISO 4217 format of the currency i.e. `USD`. */
+    /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */
     currency?: string;
     /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
     value?: string | null;
@@ -172,11 +184,11 @@ 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`. */
     qrCode?: string;
@@ -205,8 +217,8 @@ 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}`
+     * Shown as a 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`
      */
     checkInUrl?: string;
@@ -215,7 +227,7 @@ export interface TicketingTicket {
     /** Associated order checkout channel type */
     channel?: ChannelType;
     /**
-     * URL to download ticket in .pkpass format for Apple Wallet
+     * URL to download ticket in the `.pkpass` format for Apple Wallet
      * @readonly
      */
     walletPassUrl?: string;
@@ -289,7 +301,7 @@ export interface Invoice {
     items?: Item[];
     /** Total cart amount. */
     total?: Money;
-    /** Discount applied to cart. */
+    /** Discount applied to a cart. */
     discount?: Discount;
     /** Tax applied to cart. */
     tax?: Tax;
@@ -311,7 +323,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. This value is only returned when the order is paid. */
     previewUrl?: string | null;
 }
 export interface Item {
@@ -323,7 +335,7 @@ export interface Item {
     name?: string;
     /** Line item price. */
     price?: Money;
-    /** Total price for line items. Always equal to price * quantity. */
+    /** Total price for line items. It's calculated by multiplying price and item quantity. */
     total?: Money;
     /** Discount applied to the line item. */
     discount?: Discount;
@@ -338,7 +350,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. */
     code?: string;
@@ -456,7 +468,7 @@ export interface PaymentTransaction {
 export interface OrderDeleted {
     /** Order deleted timestamp in ISO UTC format. */
     timestamp?: Date;
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
@@ -545,13 +557,22 @@ export interface ListOrdersRequest {
      * - `FORM` : Returns `checkoutForm`.
      * - `INVOICE`: Returns `invoice`.
      *
-     * Default: If `fieldset` is omitted from the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn`.
+     * Default: If `fieldset` is not included in the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
      *
      */
     fieldset?: OrderFieldset[];
-    /** Status. */
+    /**
+     * Order status. Possible values:
+     * - `FREE`: The order is confirmed, no payment is required.
+     * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
+     * - `PAID`: The order is paid.
+     * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
+     * - `INITIATED`: The order is awaiting for payment.
+     * - `CANCELED`: The order is canceled.
+     * - `DECLINED`: The order is payment is declined.
+     */
     status?: OrderStatus[];
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string[];
     /** Order number. */
     orderNumber?: string[];
@@ -559,13 +580,13 @@ export interface ListOrdersRequest {
     memberId?: string[];
     /** Field facets, */
     facet?: string[];
-    /** Textual search filter - search is performed on `"full_name"`, `"email"` and `"order_number"`. */
+    /** Search filter. You can search `fullName`, `email` and `orderNumber`. */
     searchPhrase?: string;
     /** Event creator ID. */
     eventCreatorId?: string[];
     /**
-     * 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-orders).
+     * Sort order.
+     * Default: `created:asc`.
      */
     sort?: string;
     /** Order tag. */
@@ -632,7 +653,7 @@ export interface Counts {
     ticketsCheckIn?: number;
 }
 export interface GetOrderRequest {
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId: string;
     /** Unique order number. */
     orderNumber: string;
@@ -643,7 +664,8 @@ export interface GetOrderRequest {
      * - `FORM` : Returns `checkoutForm`.
      * - `INVOICE`: Returns `invoice`.
      *
-     * Default: If `fieldset` is omitted from the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn`.
+     * Default: If `fieldset` is not included in the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
+     *
      */
     fieldset?: OrderFieldset[];
 }
@@ -660,7 +682,7 @@ export interface CalendarLinks {
     ics?: string;
 }
 export interface UpdateOrderRequest {
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId: string;
     /** Unique order number. */
     orderNumber: string;
@@ -680,7 +702,7 @@ export interface OrderUpdated {
     language?: string | null;
     /** Locale in which Order was created. */
     locale?: string | null;
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
@@ -708,7 +730,16 @@ export interface OrderUpdated {
     checkoutForm?: FormResponse;
     /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
     confirmed?: boolean;
-    /** Order status. */
+    /**
+     * Order status. Possible values:
+     * - `FREE`: The order is confirmed, no payment is required.
+     * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
+     * - `PAID`: The order is paid.
+     * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
+     * - `INITIATED`: The order is awaiting for payment.
+     * - `CANCELED`: The order is canceled.
+     * - `DECLINED`: The order is payment is declined.
+     */
     status?: OrderStatus;
     /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
     method?: string | null;
@@ -720,7 +751,7 @@ export interface OrderUpdated {
     triggeredByAnonymizeRequest?: boolean;
 }
 export interface BulkUpdateOrdersRequest {
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId: string;
     orderNumber?: string[];
     /** Whether to archive the order. */
@@ -731,7 +762,7 @@ export interface BulkUpdateOrdersResponse {
     orders?: Order[];
 }
 export interface ConfirmOrderRequest {
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId: string;
     /** Order numbers. */
     orderNumber?: string[];
@@ -759,7 +790,7 @@ export interface TicketSales {
     revenue?: Money;
 }
 export interface GetInvoicePreviewRequest {
-    /** Event ID. */
+    /** Event ID to which the invoice belongs. */
     eventId?: string;
     /** Order number. */
     orderNumber?: string;
@@ -845,7 +876,7 @@ export interface OrderConfirmed {
     silent?: boolean | null;
     /** Locale in which Order was created. */
     locale?: string | null;
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
@@ -866,7 +897,16 @@ export interface OrderConfirmed {
     email?: string;
     /** Checkout form response. */
     checkoutForm?: FormResponse;
-    /** Order status. */
+    /**
+     * Order status. Possible values:
+     * - `FREE`: The order is confirmed, no payment is required.
+     * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
+     * - `PAID`: The order is paid.
+     * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
+     * - `INITIATED`: The order is awaiting for payment.
+     * - `CANCELED`: The order is canceled.
+     * - `DECLINED`: The order is payment is declined.
+     */
     status?: OrderStatus;
     /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
     method?: string | null;
@@ -880,7 +920,7 @@ export interface OrderConfirmed {
 export interface OrderPaid {
     /** Order paid timestamp in ISO UTC. */
     timestamp?: Date;
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
@@ -890,7 +930,7 @@ export interface OrderPaid {
 export interface ReservationCreated {
     /** Reservation created timestamp in ISO UTC format. */
     timestamp?: Date;
-    /** Event ID. */
+    /** Event ID to which the reservation belongs. */
     eventId?: string;
     /**
      * Reservation ID.
@@ -946,7 +986,7 @@ export interface ReservationCount {
 export interface ReservationUpdated {
     /** Reservation updated timestamp. */
     timestamp?: Date;
-    /** Event ID. */
+    /** Event ID to which the reservation belongs. */
     eventId?: string;
     /**
      * Reservation ID.
@@ -984,8 +1024,8 @@ export interface ListAvailableTicketsRequest {
     /** Limit. */
     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`.
      */
     sort?: string;
     state?: State[];
@@ -1018,14 +1058,11 @@ export interface TicketDefinition {
     name?: string;
     /** Ticket description. */
     description?: string;
-    /**
-     * Limit of tickets that can be purchased per checkout.
-     * Set to 20 for unlimited ticket definition.
-     */
+    /** Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets. */
     limitPerCheckout?: number;
     /** Custom sort index. */
     orderIndex?: number;
-    /** Policy information plain text block, as printed on the ticket. */
+    /** Event and ticket policies. */
     policy?: string;
     /** Sensitive dashboard data. */
     dashboard?: Dashboard;
@@ -1055,9 +1092,9 @@ export interface Dashboard {
     sold?: number;
     /** Whether the ticket has limited quantity. */
     limited?: boolean;
-    /** Ticket limit. `NULL` for unlimited ticket definitions. */
+    /** Ticket limit. `NULL` if the tickets are unlimited. */
     quantity?: number | null;
-    /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
+    /** Number of unsold tickets. `NULL` if the tickets are unlimited. */
     unsold?: number | null;
     /** Number of tickets sold. */
     ticketsSold?: number;
@@ -1130,7 +1167,10 @@ export interface QueryAvailableTicketsRequest {
     /** Ticket definition. */
     filter?: Record<string, any> | null;
     fieldset?: TicketDefinitionFieldset[];
-    /** Sort order, defaults to "created:asc". */
+    /**
+     * Sort order.
+     * Default: `created:asc`.
+     */
     sort?: string;
 }
 export declare enum TicketDefinitionFieldset {
@@ -1146,7 +1186,7 @@ export interface QueryAvailableTicketsResponse {
     definitions?: TicketDefinition[];
 }
 export interface CreateReservationRequest {
-    /** Event ID. */
+    /** Event ID to which the reservation belongs. */
     eventId: string;
     /** Tickets to reserve. */
     ticketQuantities?: TicketReservationQuantity[];
@@ -1160,7 +1200,7 @@ export interface TicketReservationQuantity {
     ticketDefinitionId?: string;
     /** Quantity of tickets to reserve. */
     quantity?: number;
-    /** Ticket price to charge - overriding the ticket price. */
+    /** Override the predefined ticket price. */
     priceOverride?: string | null;
     /** Optional ticket details */
     ticketDetails?: TicketDetails[];
@@ -1184,7 +1224,7 @@ export interface TicketReservation {
     ticketDetails?: TicketDetails[];
 }
 export interface CancelReservationRequest {
-    /** Event ID. */
+    /** Event ID to which the reservation belongs. */
     eventId: string;
     /** Reservation ID. */
     _id: string;
@@ -1192,7 +1232,7 @@ export interface CancelReservationRequest {
 export interface CancelReservationResponse {
 }
 export interface GetInvoiceRequest {
-    /** Event ID. */
+    /** Event ID to which the invoice belongs. */
     eventId: string;
     /** Reservation ID. */
     reservationId: string;
@@ -1216,9 +1256,16 @@ export interface GetInvoiceResponse {
     invoice?: Invoice;
     /** Discount errors, if relevant. */
     discountErrors?: DiscountErrors;
-    /** Time when the reservation expires. */
+    /** Reservation expiration time. */
     expires?: Date;
-    /** Reservation status. */
+    /**
+     * Reservation status. Possible values:
+     * - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time.
+     * - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire.
+     * - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid.
+     * - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer.
+     * - `RESERVATION_EXPIRED`: The reservation has expired.
+     */
     reservationStatus?: ReservationStatus;
     /** Whether this reservation is already used in checkout. */
     reservationOccupied?: boolean;
@@ -1234,7 +1281,7 @@ export interface Error {
     code?: string;
 }
 export interface CheckoutRequest {
-    /** Event ID. */
+    /** Event ID to which the checkout belongs. */
     eventId: string;
     /** Ticket reservation ID. */
     reservationId?: string;
@@ -1276,11 +1323,14 @@ export interface CheckoutOptions {
 export interface CheckoutResponse {
     /** Created order. */
     order?: Order;
-    /** Time when the order expires, applies to orders with status = INITIATED. */
+    /**
+     * Order expiration time.
+     * **Note:** Only applicable to orders with the `INITIATED` status.
+     */
     expires?: Date;
     /** Ticket reservations. */
     reservations?: TicketReservation[];
-    /** Order page url. */
+    /** Order page URL. */
     orderPageUrl?: string | null;
 }
 export interface OrderInitiated {
@@ -1290,7 +1340,7 @@ export interface OrderInitiated {
     language?: string | null;
     /** Locale in which Order was created. */
     locale?: string | null;
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
@@ -1316,7 +1366,16 @@ export interface OrderInitiated {
     email?: string;
     /** Checkout form response. */
     checkoutForm?: FormResponse;
-    /** Order status. */
+    /**
+     * Order status. Possible values:
+     * - `FREE`: The order is confirmed, no payment is required.
+     * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
+     * - `PAID`: The order is paid.
+     * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
+     * - `INITIATED`: The order is awaiting for payment.
+     * - `CANCELED`: The order is canceled.
+     * - `DECLINED`: The order is payment is declined.
+     */
     status?: OrderStatus;
     /** Invoice. */
     invoice?: Invoice;
@@ -1326,7 +1385,7 @@ export interface OrderInitiated {
     markedAsPaid?: boolean | null;
 }
 export interface UpdateCheckoutRequest {
-    /** Event ID. */
+    /** Event ID to which the checkout belongs. */
     eventId: string;
     /** Unique order number. */
     orderNumber: string;
@@ -1344,21 +1403,21 @@ 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. */
     success?: string | null;
-    /** Pending order page url. */
+    /** Pending order page URL. */
     pending?: string | null;
-    /** Canceled order page url. */
+    /** Canceled order page URL. */
     canceled?: string | null;
-    /** Error order page url. */
+    /** Error order page URL. */
     error?: string | null;
 }
 export interface PosCheckoutRequest {
-    /** Event ID. */
+    /** Event ID to which the checkout belongs. */
     eventId?: string;
     /** Ticket reservation ID. */
     reservationId?: string;
@@ -3441,12 +3500,8 @@ export declare const onOrderReservationCreated: EventDefinition<ReservationCreat
 export declare const onOrderReservationUpdated: EventDefinition<ReservationUpdated, "wix.events.ticketing.events.ReservationUpdated">;
 export declare const onOrderInitiated: EventDefinition<OrderInitiated, "wix.events.ticketing.events.OrderInitiated">;
 /**
- * Retrieves a list of orders, including ticket data, with basic filter support.
- * <!--
- * > 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.
- * -->
+ * Retrieves a list of orders, including ticket data.
  * @public
- * @documentationMaturity preview
  * @param options - An object representing the available options for retrieving a list of orders.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
@@ -3471,13 +3526,21 @@ export interface ListOrdersOptions {
      * - `FORM` : Returns `checkoutForm`.
      * - `INVOICE`: Returns `invoice`.
      *
-     * Default: If `fieldset` is omitted from the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn`.
-     *
+     * Default: If `fieldset` is not included in the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
      */
     fieldset?: OrderFieldset[];
-    /** Status. */
+    /**
+     * Order status. Possible values:
+     * - `FREE`: The order is confirmed, no payment is required.
+     * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
+     * - `PAID`: The order is paid.
+     * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
+     * - `INITIATED`: The order is awaiting for payment.
+     * - `CANCELED`: The order is canceled.
+     * - `DECLINED`: The order is payment is declined.
+     */
     status?: OrderStatus[];
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId?: string[];
     /** Order number. */
     orderNumber?: string[];
@@ -3485,17 +3548,13 @@ export interface ListOrdersOptions {
     memberId?: string[];
     /** Field facets. */
     facet?: string[];
-    /** Textual search filter - search is performed on `"full_name"`, `"email"` and `"order_number"`. */
+    /** Search filter. You can search `fullName`, `email` and `orderNumber`. */
     searchPhrase?: string;
     /** Event creator ID. */
     eventCreatorId?: string[];
     /**
      * Sort order.
-     *
-     * Default: `"created"`:`"asc"`.
-     *
-     *
-     * See [Orders Sort](/wix-events-v2/orders/orders-sort) for more information.
+     * Default: `created:asc`.
      */
     sort?: string;
     /** Order tag. */
@@ -3507,7 +3566,6 @@ export interface ListOrdersOptions {
  * >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.
  * -->
  * @public
- * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.eventId
  * @requiredField identifiers.orderNumber
@@ -3526,7 +3584,7 @@ export interface ListOrdersOptions {
  */
 export declare function getOrder(identifiers: GetOrderIdentifiers, options?: GetOrderOptions): Promise<Order & NonNullable<GetOrderResponseNonNullableFields>['order']>;
 export interface GetOrderIdentifiers {
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId: string;
     /** Unique order number. */
     orderNumber: string;
@@ -3539,20 +3597,13 @@ export interface GetOrderOptions {
      * - `FORM` : Returns `checkoutForm`.
      * - `INVOICE`: Returns `invoice`.
      *
-     * Default: If `fieldset` is omitted from the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn`.
+     * Default: If `fieldset` is not included in the request,  `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
      */
     fieldset?: OrderFieldset[];
 }
 /**
  * Updates an order.
- *
- *
- * See [Partial Updates](/wix-events-v2/partial-updates) for more information.
- * <!--
- * >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.
- * -->
  * @public
- * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.eventId
  * @requiredField identifiers.orderNumber
@@ -3566,7 +3617,7 @@ export interface GetOrderOptions {
  */
 export declare function updateOrder(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions): Promise<UpdateOrderResponse & UpdateOrderResponseNonNullableFields>;
 export interface UpdateOrderIdentifiers {
-    /** Event ID. */
+    /** Event ID to which the order belongs. */
     eventId: string;
     /** Unique order number. */
     orderNumber: string;
@@ -3578,18 +3629,11 @@ export interface UpdateOrderOptions {
     archived?: boolean;
 }
 /**
- * Updates multiple orders' `archived` status.
- *
- *
- * See [Partial Updates](/wix-events-v2/partial-updates) for more information.
- * <!--
- * >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.
- * -->
- * @param eventId - Event ID.
+ * Archives multiple orders.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @param options - An object representing the available options for confirming an order.
+ * @param eventId - Event ID to which the order belongs.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders
@@ -3604,15 +3648,15 @@ export interface BulkUpdateOrdersOptions {
     archived?: boolean;
 }
 /**
- * Changes order status from "INITIATED, "PENDING", or "OFFLINE_PENDING" to "PAID". Previously confirmed orders (with status "PAID" or "FREE") are not changed. Confirming previously "INITIATED" or "PENDING" orders triggers an email with the tickets to the buyer (and to additional guests, if relevant and provided).
- * <!--
- * > 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.
- * -->
- * @param eventId - Event ID.
+ * Confirms an order.
+ *
+ *
+ * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
+ * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @param options - An object representing the available options for confirming an order.
+ * @param eventId - Event ID to which the order belongs.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders
@@ -3630,7 +3674,6 @@ export interface ConfirmOrderOptions {
  * > 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.
  * -->
  * @public
- * @documentationMaturity preview
  * @param options - An object representing the available options for retrieving a summary of total ticket sales.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
@@ -3648,12 +3691,8 @@ export interface GetSummaryOptions {
     eventId?: string | null;
 }
 /**
- * Returns checkout meta data used in checkout UX.
- * <!--
- * > 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.
- * -->
+ * Retrieves checkout details.
  * @public
- * @documentationMaturity preview
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders
@@ -3669,7 +3708,6 @@ export declare function getCheckoutOptions(): Promise<GetCheckoutOptionsResponse
  * > 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.
  * -->
  * @public
- * @documentationMaturity preview
  * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
@@ -3687,7 +3725,10 @@ export interface ListAvailableTicketsOptions {
     offset?: number;
     /** Limit. */
     limit?: number;
-    /** Sort order, defaults to "created:asc". */
+    /**
+     * Sort order.
+     * Default: `created:asc`.
+     */
     sort?: string;
     state?: State[];
 }
@@ -3697,7 +3738,6 @@ export interface ListAvailableTicketsOptions {
  * > 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.
  * -->
  * @public
- * @documentationMaturity preview
  * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
@@ -3716,21 +3756,22 @@ export interface QueryAvailableTicketsOptions {
     /** Ticket definition. */
     filter?: Record<string, any> | null;
     fieldset?: TicketDefinitionFieldset[];
-    /** Sort order, defaults to "created:asc". */
+    /**
+     * Sort order.
+     * Default: `created:asc`.
+     */
     sort?: string;
 }
 /**
  * Reserves tickets for 20 minutes.
- * Reserved tickets are deducted from tickets stock and cannot be bought by another party.
- * When the reservation expires, the tickets are added back in the stock.
- * <!--
- * > 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.
- * -->
- * @param eventId - Event ID.
+ *
+ *
+ * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
+ * When the reservation expires, the tickets are added back to the stock.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @param options - An object representing the available options for creating a reservation.
+ * @param eventId - Event ID to which the reservation belongs.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders
@@ -3754,12 +3795,11 @@ export interface CreateReservationOptions {
  * > 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.
  * -->
  * @param _id - Reservation ID.
- * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField eventId
  * @param identifiers - An object containing identifiers for the reservation to be cancelled.
+ * @param eventId - Event ID to which the reservation belongs.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders
@@ -3770,18 +3810,14 @@ export interface CreateReservationOptions {
  */
 export declare function cancelReservation(_id: string, eventId: string): Promise<void>;
 /**
- * Generates a preview of a reservation invoice, including the given coupon or pricing plan.
- * <!--
- * > 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.
- * -->
+ * Generates a preview of an invoice, including the given coupon or pricing plan.
  * @param reservationId - Reservation ID.
- * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @requiredField reservationId
  * @param options - An object representing the available options for generating a preview of a reservation invoice.
  * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
+ * @param eventId - Event ID to which the invoice belongs.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Events - all permissions
@@ -3802,28 +3838,22 @@ export interface GetInvoiceOptions {
     paidPlanBenefit?: PaidPlanBenefit;
 }
 /**
- * Checkout of reserved tickets.
+ * Checkouts the reserved tickets.
  *
  *
- * Creates order and associates it with a site contact.
- * Guest details must be sent according to the Registration Form input fields.
- * (To change an existing "INITIATED, "PENDING", or "OFFLINE_PENDING" order, call the [Update Checkout](https://dev.wix.com/api/rest/wix-events/wix-events/checkout/update-checkout) endpoint).
+ * Creates an order and associates it with a site visitor contact.
+ * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
  *
  * 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.
- * To construct 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:
+ * 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:
  * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
  *
  * Example:  `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
- *
- * <!--
- * > 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.
- * -->
- * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @requiredField options.guests.form
  * @param options - An object representing the available options for checking out a reserved ticket.
+ * @param eventId - Event ID to which the checkout belongs.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders
@@ -3850,19 +3880,17 @@ export interface CheckoutOptionsForRequest {
     options?: CheckoutOptions;
 }
 /**
- * Updates order and tickets (supported only for unconfirmed orders).
- * Guest details must be sent according to Registration Form input fields.
- * <!--
- * > 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.
- * -->
+ * Updates order and tickets.
+ *
+ *
+ * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
  * @param orderNumber - Unique order number.
- * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @requiredField orderNumber
  * @param options - An object representing the available options for updating an order and tickets.
  * @param identifiers - An object containing identifiers for the order and tickets to be updated.
+ * @param eventId - Event ID to which the checkout belongs.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Orders