@wix/auto_sdk_events_orders 1.0.23 → 1.0.25

package/build/es/meta.d.mts

@@ -1,4 +1,5 @@
-import { aw as ListOrdersRequest$1, a as ListOrdersResponse$1, aB as GetOrderRequest$1, aC as GetOrderResponse$1, aE as UpdateOrderRequest$1, d as UpdateOrderResponse$1, aG as BulkUpdateOrdersRequest$1, e as BulkUpdateOrdersResponse$1, aH as ConfirmOrderRequest$1, f as ConfirmOrderResponse$1, aI as GetSummaryRequest$1, h as GetSummaryResponse$1, aR as CaptureAuthorizedPaymentRequest$1, aS as CaptureAuthorizedPaymentResponse$1, aT as VoidAuthorizedPaymentRequest$1, aU as VoidAuthorizedPaymentResponse$1, b4 as GetCheckoutOptionsRequest$1, j as GetCheckoutOptionsResponse$1, b5 as ListAvailableTicketsRequest$1, l as ListAvailableTicketsResponse$1, bf as QueryAvailableTicketsRequest$1, m as QueryAvailableTicketsResponse$1, bg as CreateReservationRequest$1, o as CreateReservationResponse$1, bj as CancelReservationRequest$1, bk as CancelReservationResponse$1, bl as GetInvoiceRequest$1, q as GetInvoiceResponse$1, bs as CheckoutRequest$1, s as CheckoutResponse$1, bx as UpdateCheckoutRequest$1, u as UpdateCheckoutResponse$1, bz as PosCheckoutRequest$1, v as PosCheckoutResponse$1 } from './events-v1-order-orders.universal-BK8XPFRp.mjs';
+import { ListOrdersRequest as ListOrdersRequest$1, ListOrdersResponse as ListOrdersResponse$1, GetOrderRequest as GetOrderRequest$1, GetOrderResponse as GetOrderResponse$1, UpdateOrderRequest as UpdateOrderRequest$1, UpdateOrderResponse as UpdateOrderResponse$1, BulkUpdateOrdersRequest as BulkUpdateOrdersRequest$1, BulkUpdateOrdersResponse as BulkUpdateOrdersResponse$1, ConfirmOrderRequest as ConfirmOrderRequest$1, ConfirmOrderResponse as ConfirmOrderResponse$1, GetSummaryRequest as GetSummaryRequest$1, GetSummaryResponse as GetSummaryResponse$1, CaptureAuthorizedPaymentRequest as CaptureAuthorizedPaymentRequest$1, CaptureAuthorizedPaymentResponse as CaptureAuthorizedPaymentResponse$1, VoidAuthorizedPaymentRequest as VoidAuthorizedPaymentRequest$1, VoidAuthorizedPaymentResponse as VoidAuthorizedPaymentResponse$1, GetCheckoutOptionsRequest as GetCheckoutOptionsRequest$1, GetCheckoutOptionsResponse as GetCheckoutOptionsResponse$1, ListAvailableTicketsRequest as ListAvailableTicketsRequest$1, ListAvailableTicketsResponse as ListAvailableTicketsResponse$1, QueryAvailableTicketsRequest as QueryAvailableTicketsRequest$1, QueryAvailableTicketsResponse as QueryAvailableTicketsResponse$1, CreateReservationRequest as CreateReservationRequest$1, CreateReservationResponse as CreateReservationResponse$1, CancelReservationRequest as CancelReservationRequest$1, CancelReservationResponse as CancelReservationResponse$1, GetInvoiceRequest as GetInvoiceRequest$1, GetInvoiceResponse as GetInvoiceResponse$1, CheckoutRequest as CheckoutRequest$1, CheckoutResponse as CheckoutResponse$1, UpdateCheckoutRequest as UpdateCheckoutRequest$1, UpdateCheckoutResponse as UpdateCheckoutResponse$1, PosCheckoutRequest as PosCheckoutRequest$1, PosCheckoutResponse as PosCheckoutResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
 
 interface Order {
     /** Unique order number. */
@@ -21,7 +22,7 @@ interface Order {
      */
     eventId?: string;
     /**
-     * Contact ID of buyer, resolved using the email address provided. See the Contacts API for additional information.
+     * Contact ID of buyer, resolved using the email address specified. See the Contacts API for additional information.
      * @format GUID
      */
     contactId?: string;
@@ -31,7 +32,7 @@ interface Order {
      */
     memberId?: string;
     /**
-     * Date and time the RSVP was created.
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
@@ -40,7 +41,7 @@ interface Order {
     /** Guest last name. */
     lastName?: string;
     /**
-     * Guest email.
+     * Guest email address.
      * @format EMAIL
      */
     email?: string;
@@ -50,7 +51,7 @@ interface Order {
     confirmed?: boolean;
     /** Order status. */
     status?: OrderStatusWithLiterals;
-    /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
+    /** Payment method used for purchase, for example, "payPal", "creditCard", etc. */
     method?: string;
     /** Amount of tickets ordered. */
     ticketsQuantity?: number;
@@ -68,14 +69,14 @@ interface Order {
     fullName?: string;
     /** Order invoice. */
     invoice?: Invoice;
-    /** Whether all tickets in an order are checked-in. */
+    /** Whether all tickets in an order are checked in. */
     fullyCheckedIn?: boolean;
-    /** Internal order payment details */
+    /** Internal order payment details. */
     paymentDetails?: PaymentDetails;
     /** Checkout channel type. */
     channel?: ChannelTypeWithLiterals;
     /**
-     * Date and time the order was updated.
+     * Date and time the order was last updated.
      * @readonly
      */
     updated?: Date | null;
@@ -84,31 +85,31 @@ interface Order {
 }
 interface FormResponse {
     /**
-     * Input values entered when filling the form.
+     * Form field inputs.
      * @maxSize 200
      */
     inputValues?: InputValue[];
 }
 interface InputValue {
     /**
-     * Input field name.
+     * Form field input name.
      * @maxLength 100
      */
     inputName?: string;
     /**
-     * Text entered into the input field.
+     * Form field value.
      * @maxLength 5000
      */
     value?: string;
     /**
-     * Multiple input values. For example, the array is filled if several checkboxes are ticked.
+     * Form field values.
      * @maxSize 100
      * @maxLength 5000
      */
     values?: string[];
 }
 declare enum OrderStatus {
-    /** Order status is not available for this request fieldset. */
+    /** Order status isn't available for this request fieldset. */
     NA_ORDER_STATUS = "NA_ORDER_STATUS",
     /** Order is confirmed, no payment is required. */
     FREE = "FREE",
@@ -116,9 +117,9 @@ declare enum OrderStatus {
     PENDING = "PENDING",
     /** Order is paid. */
     PAID = "PAID",
-    /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
+    /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
     OFFLINE_PENDING = "OFFLINE_PENDING",
-    /** Order is awaiting for payment at the cashier. */
+    /** Order is waiting for payment at the cashier. */
     INITIATED = "INITIATED",
     /** Order is canceled. */
     CANCELED = "CANCELED",
@@ -141,7 +142,7 @@ interface Money {
      */
     amount?: string;
     /**
-     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
      * @format CURRENCY
      */
     currency?: string;
@@ -152,7 +153,7 @@ interface Money {
     value?: string | null;
 }
 interface TicketingTicket {
-    /** Unique ticket number (issued automatically). */
+    /** Unique ticket number which is assigned automatically when creating a ticket. */
     ticketNumber?: string;
     /** Associated order number. */
     orderNumber?: string;
@@ -170,20 +171,15 @@ interface TicketingTicket {
      * @readonly
      */
     free?: boolean;
-    /** Event and ticket policies. */
+    /** Ticket and event policies. */
     policy?: string;
-    /**
-     * *Deprecated:** Use `tickets.checkInUrl` instead.
-     * @deprecated
-     */
-    qrCode?: string;
     /** Ticket check-in. */
     checkIn?: CheckIn;
     /** Associated order status. */
     orderStatus?: OrderStatusWithLiterals;
     /**
      * Whether the order and ticket are archived.
-     * If set to `true`, they are not visible in the order list.
+     * If set to `true`, they aren't visible in the order list.
      */
     orderArchived?: boolean;
     /** Buyer full name. */
@@ -192,13 +188,8 @@ interface TicketingTicket {
     guestFullName?: string | null;
     /** Guest personal details. */
     guestDetails?: GuestDetails;
-    /** Whether ticket is visible in guest list. */
+    /** Whether the ticket is visible in an order. */
     archived?: boolean;
-    /**
-     * *Deprecated:** Use `tickets.ticketPdfUrl` instead.
-     * @deprecated
-     */
-    ticketPdf?: string;
     /**
      * Ticket owner member ID.
      * @format GUID
@@ -222,7 +213,7 @@ interface TicketingTicket {
     /** Associated order checkout channel type. */
     channel?: ChannelTypeWithLiterals;
     /**
-     * URL to download ticket in `.pkpass` format for Apple Wallet.
+     * URL to download a ticket in `.pkpass` format for Apple Wallet.
      * @format WEB_URL
      * @readonly
      */
@@ -234,7 +225,7 @@ interface TicketingTicket {
     canceled?: boolean | null;
 }
 interface CheckIn {
-    /** Time of check-in. */
+    /** Time of a ticket's check-in. */
     created?: Date | null;
 }
 interface GuestDetails {
@@ -263,7 +254,7 @@ interface GuestDetails {
     phone?: string | null;
 }
 declare enum ChannelType {
-    /** Buyer created the order via an online channel, such as a website or a mobile app. */
+    /** Buyer created the order via an online channel, such as a website or mobile app. */
     ONLINE = "ONLINE",
     /** Sales person created the order and collected the money. */
     OFFLINE_POS = "OFFLINE_POS"
@@ -343,8 +334,8 @@ interface Invoice {
      * 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).
-     * 3. Tax is added (if applicable).
+     * 2. Discount is subtracted from the cart, if applicable.
+     * 3. Tax is added, if applicable.
      * 4. Wix ticket service fee is added.
      */
     grandTotal?: Money;
@@ -353,7 +344,7 @@ interface Invoice {
      * @readonly
      */
     fees?: Fee[];
-    /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
+    /** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
     revenue?: Money;
     /** Invoice preview URL. Only returned if the order is paid. */
     previewUrl?: string | null;
@@ -511,7 +502,7 @@ declare enum FeeType {
 /** @enumType */
 type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
 interface PaymentDetails {
-    /** Wix Payments transaction */
+    /** Wix Payments transaction. */
     transaction?: PaymentTransaction;
 }
 interface PaymentTransaction {
@@ -522,7 +513,7 @@ interface PaymentTransaction {
      */
     transactionId?: string;
     /**
-     * Transaction Payment method e.g., "payPal", "creditCard", etc.
+     * Transaction payment method, for example, "payPal", "creditCard", etc.
      * @readonly
      */
     method?: string;
@@ -808,9 +799,9 @@ interface VoidAuthorizedPaymentRequest {
 interface VoidAuthorizedPaymentResponse {
 }
 declare enum ReservationStatus {
-    /** The Reservation is pending confirmation. It will expire after a certain amount of 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. */
+    /** The reservation is confirmed and won't expire. */
     RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
     /** The reservation is canceled because it's not paid. */
     RESERVATION_CANCELED = "RESERVATION_CANCELED",
@@ -828,7 +819,7 @@ 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 doesn't 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;
@@ -837,7 +828,7 @@ interface GetCheckoutOptionsResponse {
 }
 interface ListAvailableTicketsRequest {
     /**
-     * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
+     * Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
      * @format GUID
      */
     eventId?: string;
@@ -952,7 +943,7 @@ interface TicketSalePeriod {
     startDate?: Date | null;
     /** Ticket sale end timestamp. */
     endDate?: Date | null;
-    /** Whether to hide this ticket if it's not on sale */
+    /** Whether to hide this ticket if it isn't on sale. */
     hideNotOnSale?: boolean;
 }
 declare enum TicketSaleStatus {
@@ -1084,7 +1075,7 @@ interface TicketReservationQuantity {
      * @format DECIMAL_VALUE
      */
     priceOverride?: string | null;
-    /** Optional ticket details */
+    /** Optional ticket details. */
     ticketDetails?: TicketDetails[];
 }
 interface CreateReservationResponse {
@@ -1194,7 +1185,7 @@ interface CheckoutRequest {
      * @format GUID
      */
     reservationId?: string;
-    /** Member ID (if empty - no site member is associated to this order). */
+    /** Member ID. If empty, no site member is associated with this order. */
     memberId?: string;
     /** Discount to apply on the invoice. */
     discount?: DiscountRequest;
@@ -1210,7 +1201,7 @@ interface CheckoutRequest {
     paidPlanBenefit?: PaidPlanBenefit;
     /** Options controlling the checkout process. */
     options?: CheckoutOptions;
-    /** Whether marketing consent was given */
+    /** Whether marketing consent was given. */
     marketingConsent?: boolean | null;
 }
 interface Buyer {
@@ -1241,7 +1232,7 @@ interface Guest {
 interface CheckoutOptions {
     /** 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. */
+    /** 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;
     /** Whether to ignore form validation. */
     ignoreFormValidation?: boolean;
@@ -1280,7 +1271,7 @@ interface UpdateCheckoutRequest {
     /**
      * Member ID.
      *
-     * If empty, no site member is associated to this order.
+     * If empty, no site member is associated with this order.
      */
     memberId?: string | null;
     /** Discount to apply on the invoice. */
@@ -1307,7 +1298,7 @@ interface PosCheckoutRequest {
     reservationId: string;
     /**
      * Payment details ID.
-     * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
+     * Not required if reservation total is 0. In this case the order will be created with status `FREE` and no payment.
      * @format GUID
      */
     paymentDetailsId?: string | null;
@@ -1315,7 +1306,7 @@ interface PosCheckoutRequest {
 interface PosCheckoutResponse {
     /** Created order. */
     order?: Order;
-    /** Time when the order expires, applies to orders with status = INITIATED. */
+    /** Time when the order expires, applies to orders with status is `INITIATED`. */
     expires?: Date | null;
     /** Ticket reservations. */
     reservations?: TicketReservation[];

package/build/internal/cjs/index.d.ts

@@ -1,14 +1,17 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { L as ListOrdersOptions, a as ListOrdersResponse, G as GetOrderIdentifiers, b as GetOrderOptions, O as Order, U as UpdateOrderIdentifiers, c as UpdateOrderOptions, d as UpdateOrderResponse, B as BulkUpdateOrdersOptions, e as BulkUpdateOrdersResponse, C as ConfirmOrderOptions, f as ConfirmOrderResponse, g as GetSummaryOptions, h as GetSummaryResponse, i as CaptureAuthorizedPaymentOptions, V as VoidAuthorizedPaymentOptions, j as GetCheckoutOptionsResponse, k as ListAvailableTicketsOptions, l as ListAvailableTicketsResponse, Q as QueryAvailableTicketsOptions, m as QueryAvailableTicketsResponse, n as CreateReservationOptions, o as CreateReservationResponse, p as GetInvoiceOptions, q as GetInvoiceResponse, r as CheckoutOptionsForRequest, s as CheckoutResponse, t as UpdateCheckoutOptions, u as UpdateCheckoutResponse, P as PosCheckoutOptions, v as PosCheckoutResponse, w as OrderDeletedEnvelope, x as OrderUpdatedEnvelope, y as OrderConfirmedEnvelope, z as OrderInitiatedEnvelope, A as OrderReservationCreatedEnvelope, D as OrderReservationUpdatedEnvelope } from './events-v1-order-orders.universal-BK8XPFRp.js';
-export { K as Action, a3 as Address, a6 as AddressLocation, a4 as AddressStreetOneOf, as as BalanceSummary, bK as BaseEventMetadata, aG as BulkUpdateOrdersRequest, bt as Buyer, aD as CalendarLinks, bj as CancelReservationRequest, bk as CancelReservationResponse, aR as CaptureAuthorizedPaymentRequest, aS as CaptureAuthorizedPaymentResponse, F as ChannelType, ab as CheckIn, bv as CheckoutOptions, bs as CheckoutRequest, aH as ConfirmOrderRequest, bD as ConfirmReservationRequest, bE as ConfirmReservationResponse, aA as Counts, aj as CouponDiscount, bg as CreateReservationRequest, b8 as Dashboard, ag as Discount, bo as DiscountErrors, ah as DiscountItem, ai as DiscountItemDiscountOneOf, bm as DiscountRequest, bp as Error, bI as EventKey, bF as ExpireReservationRequest, bG as ExpireReservationResponse, ax as FacetCounts, ao as Fee, H as FeeName, I as FeeType, aV as FindOrderByReservationIdRequest, aW as FindOrderByReservationIdResponse, a0 as FormResponse, a2 as FormattedAddress, b4 as GetCheckoutOptionsRequest, aK as GetInvoicePreviewRequest, bl as GetInvoiceRequest, aB as GetOrderRequest, aC as GetOrderResponse, aN as GetPaymentInfoRequest, aO as GetPaymentInfoResponse, bA as GetReservationRequest, bB as GetReservationResponse, aI as GetSummaryRequest, bq as GiftCardErrors, br as GiftCardErrorsError, ar as GiftCardPaymentDetails, bu as Guest, ac as GuestDetails, aM as HeadersEntry, aY as IdentificationData, aZ as IdentificationDataIdOneOf, a1 as InputValue, ae as Invoice, af as Item, b5 as ListAvailableTicketsRequest, aw as ListOrdersRequest, aX as MessageEnvelope, a9 as Money, av as OnlineConferencingLogin, a_ as OrderConfirmed, at as OrderDeleted, az as OrderFacetCounts, ay as OrderFacets, N as OrderFieldset, bw as OrderInitiated, by as OrderPageUrls, a$ as OrderPaid, E as OrderStatus, R as OrderTag, M as OrderType, aF as OrderUpdated, bn as PaidPlanBenefit, ak as PaidPlanDiscount, al as PaidPlanDiscountDiscountOneOf, ap as PaymentDetails, aq as PaymentTransaction, aQ as PaymentTransactionEvent, aP as PaymentTransactionSummary, am as PercentDiscount, bz as PosCheckoutRequest, be as PricingOption, bd as PricingOptions, bf as QueryAvailableTicketsRequest, bH as QueryEventsWithPaidReservationsRequest, bJ as QueryEventsWithPaidReservationsResponse, aL as RawHttpResponse, bC as Reservation, b2 as ReservationCount, b0 as ReservationCreated, X as ReservationStatus, b3 as ReservationUpdated, b6 as ResponseMetaData, J as ScheduledActionEnumAction, a8 as StandardDetails, Y as State, a5 as StreetAddress, a7 as Subdivision, S as SubdivisionType, an as Tax, T as TaxType, au as Ticket, b7 as TicketDefinition, $ as TicketDefinitionFieldset, ad as TicketDetails, bb as TicketPricing, bc as TicketPricingPriceOneOf, b1 as TicketQuantity, bi as TicketReservation, bh as TicketReservationQuantity, ba as TicketSalePeriod, Z as TicketSaleStatus, aJ as TicketSales, aa as TicketingTicket, _ as Type, bx as UpdateCheckoutRequest, aE as UpdateOrderRequest, aT as VoidAuthorizedPaymentRequest, aU as VoidAuthorizedPaymentResponse, W as WebhookIdentityType, b9 as WixFeeConfig } from './events-v1-order-orders.universal-BK8XPFRp.js';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { ListOrdersOptions, ListOrdersResponse, GetOrderIdentifiers, GetOrderOptions, Order, UpdateOrderIdentifiers, UpdateOrderOptions, UpdateOrderResponse, UpdateOrderApplicationErrors, BulkUpdateOrdersOptions, BulkUpdateOrdersResponse, BulkUpdateOrdersApplicationErrors, ConfirmOrderOptions, ConfirmOrderResponse, ConfirmOrderApplicationErrors, GetSummaryOptions, GetSummaryResponse, CaptureAuthorizedPaymentOptions, CaptureAuthorizedPaymentApplicationErrors, VoidAuthorizedPaymentOptions, VoidAuthorizedPaymentApplicationErrors, GetCheckoutOptionsResponse, ListAvailableTicketsOptions, ListAvailableTicketsResponse, QueryAvailableTicketsOptions, QueryAvailableTicketsResponse, CreateReservationOptions, CreateReservationResponse, GetInvoiceOptions, GetInvoiceResponse, CheckoutOptionsForRequest, CheckoutResponse, UpdateCheckoutOptions, UpdateCheckoutResponse, PosCheckoutOptions, PosCheckoutResponse, OrderDeletedEnvelope, OrderUpdatedEnvelope, OrderConfirmedEnvelope, OrderInitiatedEnvelope, OrderReservationCreatedEnvelope, OrderReservationUpdatedEnvelope } from './index.typings.js';
+export { Action, Address, AddressLocation, AddressStreetOneOf, BalanceSummary, BaseEventMetadata, BulkUpdateOrdersRequest, Buyer, CalendarLinks, CancelReservationRequest, CancelReservationResponse, CaptureAuthorizedPaymentRequest, CaptureAuthorizedPaymentResponse, ChannelType, CheckIn, CheckoutOptions, CheckoutRequest, ConfirmOrderRequest, ConfirmReservationRequest, ConfirmReservationResponse, Counts, CouponDiscount, CreateReservationRequest, Dashboard, Discount, DiscountErrors, DiscountItem, DiscountItemDiscountOneOf, DiscountRequest, Error, EventKey, ExpireReservationRequest, ExpireReservationResponse, FacetCounts, Fee, FeeName, FeeType, FindOrderByReservationIdRequest, FindOrderByReservationIdResponse, FormResponse, FormattedAddress, GetCheckoutOptionsRequest, GetInvoicePreviewRequest, GetInvoiceRequest, GetOrderRequest, GetOrderResponse, GetPaymentInfoRequest, GetPaymentInfoResponse, GetReservationRequest, GetReservationResponse, GetSummaryRequest, GiftCardErrors, GiftCardErrorsError, GiftCardPaymentDetails, Guest, GuestDetails, HeadersEntry, IdentificationData, IdentificationDataIdOneOf, InputValue, Invoice, Item, ListAvailableTicketsRequest, ListOrdersRequest, MessageEnvelope, Money, OnlineConferencingLogin, OrderConfirmed, OrderDeleted, OrderFacetCounts, OrderFacets, OrderFieldset, OrderInitiated, OrderPageUrls, OrderPaid, OrderStatus, OrderTag, OrderType, OrderUpdated, PaidPlanBenefit, PaidPlanDiscount, PaidPlanDiscountDiscountOneOf, PaymentDetails, PaymentTransaction, PaymentTransactionEvent, PaymentTransactionSummary, PercentDiscount, PosCheckoutRequest, PricingOption, PricingOptions, QueryAvailableTicketsRequest, QueryEventsWithPaidReservationsRequest, QueryEventsWithPaidReservationsResponse, RawHttpResponse, Reservation, ReservationCount, ReservationCreated, ReservationStatus, ReservationUpdated, ResponseMetaData, ScheduledActionEnumAction, StandardDetails, State, StreetAddress, Subdivision, SubdivisionType, Tax, TaxType, Ticket, TicketDefinition, TicketDefinitionFieldset, TicketDetails, TicketPricing, TicketPricingPriceOneOf, TicketQuantity, TicketReservation, TicketReservationQuantity, TicketSalePeriod, TicketSaleStatus, TicketSales, TicketingTicket, Type, UpdateCheckoutRequest, UpdateOrderRequest, VoidAuthorizedPaymentRequest, VoidAuthorizedPaymentResponse, WebhookIdentityType, WixFeeConfig } from './index.typings.js';
 
+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}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `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`;
 declare function listOrders$1(httpClient: HttpClient): ListOrdersSignature;
 interface ListOrdersSignature {
     /**
      * Retrieves a list of orders, including ticket data.
      * @param - An object representing the available options for retrieving a list of orders.
      */
-    (options?: ListOrdersOptions | undefined): Promise<ListOrdersResponse>;
+    (options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
+        [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+    }[OrderNonNullablePaths]>>;
 }
 declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
 interface GetOrderSignature {
@@ -21,7 +24,7 @@ interface GetOrderSignature {
      * @param - An object containing identifiers for the order to be retrieved.
      * @returns Requested order.
      */
-    (identifiers: GetOrderIdentifiers, options?: GetOrderOptions | undefined): Promise<Order>;
+    (identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
 }
 declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
 interface UpdateOrderSignature {
@@ -30,7 +33,11 @@ interface UpdateOrderSignature {
      * @param - An object representing the available options for updating an order.
      * @param - An object containing identifiers for the order to be updated.
      */
-    (identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions | undefined): Promise<UpdateOrderResponse>;
+    (identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths]> & {
+        __applicationErrorsType?: UpdateOrderApplicationErrors;
+    }>;
 }
 declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
 interface BulkUpdateOrdersSignature {
@@ -39,7 +46,11 @@ interface BulkUpdateOrdersSignature {
      * @param - An object representing the available options for confirming an order.
      * @param - Event ID to which the order belongs.
      */
-    (eventId: string, options?: BulkUpdateOrdersOptions | undefined): Promise<BulkUpdateOrdersResponse>;
+    (eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
+        [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+    }[OrderNonNullablePaths]> & {
+        __applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
+    }>;
 }
 declare function confirmOrder$1(httpClient: HttpClient): ConfirmOrderSignature;
 interface ConfirmOrderSignature {
@@ -52,7 +63,11 @@ interface ConfirmOrderSignature {
      * @param - An object representing the available options for confirming an order.
      * @param - Event ID to which the order belongs.
      */
-    (eventId: string, options?: ConfirmOrderOptions | undefined): Promise<ConfirmOrderResponse>;
+    (eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
+        [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+    }[OrderNonNullablePaths]> & {
+        __applicationErrorsType?: ConfirmOrderApplicationErrors;
+    }>;
 }
 declare function getSummary$1(httpClient: HttpClient): GetSummarySignature;
 interface GetSummarySignature {
@@ -63,7 +78,7 @@ interface GetSummarySignature {
      * -->
      * @param - An object representing the available options for retrieving a summary of total ticket sales.
      */
-    (options?: GetSummaryOptions | undefined): Promise<GetSummaryResponse>;
+    (options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
 }
 declare function captureAuthorizedPayment$1(httpClient: HttpClient): CaptureAuthorizedPaymentSignature;
 interface CaptureAuthorizedPaymentSignature {
@@ -73,7 +88,9 @@ interface CaptureAuthorizedPaymentSignature {
      * For orders with non-authorized payments request will fail.
      * @param - Order number.
      */
-    (orderNumber: string, options?: CaptureAuthorizedPaymentOptions | undefined): Promise<void>;
+    (orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void & {
+        __applicationErrorsType?: CaptureAuthorizedPaymentApplicationErrors;
+    }>;
 }
 declare function voidAuthorizedPayment$1(httpClient: HttpClient): VoidAuthorizedPaymentSignature;
 interface VoidAuthorizedPaymentSignature {
@@ -83,14 +100,16 @@ interface VoidAuthorizedPaymentSignature {
      * For orders with non-authorized payments request will fail.
      * @param - Order number.
      */
-    (orderNumber: string, options?: VoidAuthorizedPaymentOptions | undefined): Promise<void>;
+    (orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void & {
+        __applicationErrorsType?: VoidAuthorizedPaymentApplicationErrors;
+    }>;
 }
 declare function getCheckoutOptions$1(httpClient: HttpClient): GetCheckoutOptionsSignature;
 interface GetCheckoutOptionsSignature {
     /**
      * Retrieves checkout details.
      */
-    (): Promise<GetCheckoutOptionsResponse>;
+    (): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
 }
 declare function listAvailableTickets$1(httpClient: HttpClient): ListAvailableTicketsSignature;
 interface ListAvailableTicketsSignature {
@@ -101,7 +120,7 @@ interface ListAvailableTicketsSignature {
      * -->
      * @param - An object representing the available options for retrieving a list of tickets available for reservation.
      */
-    (options?: ListAvailableTicketsOptions | undefined): Promise<ListAvailableTicketsResponse>;
+    (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`>>;
 }
 declare function queryAvailableTickets$1(httpClient: HttpClient): QueryAvailableTicketsSignature;
 interface QueryAvailableTicketsSignature {
@@ -112,7 +131,7 @@ interface QueryAvailableTicketsSignature {
      * -->
      * @param - An object representing the available options for retrieving a list of tickets available for reservation.
      */
-    (options?: QueryAvailableTicketsOptions | undefined): Promise<QueryAvailableTicketsResponse>;
+    (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`>>;
 }
 declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
 interface CreateReservationSignature {
@@ -125,7 +144,7 @@ interface CreateReservationSignature {
      * @param - An object representing the available options for creating a reservation.
      * @param - Event ID to which the reservation belongs.
      */
-    (eventId: string, options?: CreateReservationOptions | undefined): Promise<CreateReservationResponse>;
+    (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`>>;
 }
 declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
 interface CancelReservationSignature {
@@ -149,7 +168,7 @@ interface GetInvoiceSignature {
      * @param - An object containing identifiers for the reservation invoice preview to be generated.
      * @param - Event ID to which the invoice belongs.
      */
-    (reservationId: string, eventId: string, options?: GetInvoiceOptions | undefined): Promise<GetInvoiceResponse>;
+    (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`>>;
 }
 declare function checkout$1(httpClient: HttpClient): CheckoutSignature;
 interface CheckoutSignature {
@@ -168,7 +187,9 @@ interface CheckoutSignature {
      * @param - An object representing the available options for checking out a reserved ticket.
      * @param - Event ID to which the checkout belongs.
      */
-    (eventId: string, options?: CheckoutOptionsForRequest | undefined): Promise<CheckoutResponse>;
+    (eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[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`>>;
 }
 declare function updateCheckout$1(httpClient: HttpClient): UpdateCheckoutSignature;
 interface UpdateCheckoutSignature {
@@ -182,7 +203,9 @@ interface UpdateCheckoutSignature {
      * @param - An object containing identifiers for the order and tickets to be updated.
      * @param - Event ID to which the checkout belongs.
      */
-    (orderNumber: string, eventId: string, options?: UpdateCheckoutOptions | undefined): Promise<UpdateCheckoutResponse>;
+    (orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths]>>;
 }
 declare function posCheckout$1(httpClient: HttpClient): PosCheckoutSignature;
 interface PosCheckoutSignature {
@@ -190,7 +213,9 @@ interface PosCheckoutSignature {
      * Creates order with payment details already initiated via Cashier Pay API.
      * @param - Event ID to which the checkout belongs.
      */
-    (eventId: string, options?: PosCheckoutOptions | undefined): Promise<PosCheckoutResponse>;
+    (eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[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`>>;
 }
 declare const onOrderDeleted$1: EventDefinition<OrderDeletedEnvelope, "wix.events.ticketing.events.OrderDeleted">;
 declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.events.ticketing.events.OrderUpdated">;
@@ -217,7 +242,7 @@ declare const checkout: MaybeContext<BuildRESTFunction<typeof checkout$1> & type
 declare const updateCheckout: MaybeContext<BuildRESTFunction<typeof updateCheckout$1> & typeof updateCheckout$1>;
 declare const posCheckout: MaybeContext<BuildRESTFunction<typeof posCheckout$1> & typeof posCheckout$1>;
 /**
- * This event is triggered when an order is deleted via GDPR request.
+ * This event is triggered when an order is deleted via a GDPR request.
  */
 declare const onOrderDeleted: BuildEventDefinition<typeof onOrderDeleted$1>;
 /** */

package/build/internal/cjs/index.js

@@ -2016,6 +2016,7 @@ async function captureAuthorizedPayment2(orderNumber, options) {
   try {
     const result = await httpClient.request(reqOpts);
     sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,
@@ -2044,6 +2045,7 @@ async function voidAuthorizedPayment2(orderNumber, options) {
   try {
     const result = await httpClient.request(reqOpts);
     sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,