@wix/auto_sdk_events_orders 1.0.24 → 1.0.26

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

@@ -20,7 +20,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;
@@ -30,7 +30,7 @@ interface Order {
      */
     memberId?: string;
     /**
-     * Date and time the RSVP was created.
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
@@ -39,7 +39,7 @@ interface Order {
     /** Guest last name. */
     lastName?: string;
     /**
-     * Guest email.
+     * Guest email address.
      * @format EMAIL
      */
     email?: string;
@@ -58,7 +58,7 @@ interface Order {
      * - `DECLINED`: The order is payment is declined.
      */
     status?: OrderStatusWithLiterals;
-    /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
+    /** Payment method used for purchase, for example, "payPal", "creditCard", etc. */
     method?: string;
     /** Quantity of ordered tickets. */
     ticketsQuantity?: number;
@@ -76,14 +76,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;
@@ -117,11 +117,11 @@ interface InputValue {
 }
 interface FormattedAddress {
     /**
-     * One line address representation.
+     * 1-line address representation.
      * @maxLength 200
      */
     formatted?: string;
-    /** Address components (optional). */
+    /** Address components. */
     address?: Address;
 }
 /** Physical address */
@@ -195,7 +195,7 @@ interface StandardDetails {
     iso31662?: string | null;
 }
 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",
@@ -203,9 +203,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",
@@ -239,7 +239,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;
@@ -259,18 +259,13 @@ interface TicketingTicket {
     free?: boolean;
     /** Event and ticket 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. */
@@ -279,13 +274,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
@@ -320,7 +310,7 @@ interface TicketingTicket {
     canceled?: boolean | null;
 }
 interface CheckIn {
-    /** Time of check-in. */
+    /** Time of a ticket's check-in. */
     created?: Date | null;
 }
 interface GuestDetails {
@@ -349,7 +339,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"
@@ -430,8 +420,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;
@@ -440,7 +430,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. This value is only returned when the order is paid. */
     previewUrl?: string | null;
@@ -598,7 +588,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 {
@@ -609,7 +599,7 @@ interface PaymentTransaction {
      */
     transactionId?: string;
     /**
-     * Transaction Payment method e.g., "payPal", "creditCard", etc.
+     * Transaction payment method, for example, "payPal", "creditCard", etc.
      * @readonly
      */
     method?: string;
@@ -640,7 +630,7 @@ declare enum Action {
 type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
 interface GiftCardPaymentDetails {
     /**
-     * Gift card payment id.
+     * Gift card payment ID.
      * @format GUID
      */
     giftCardPaymentId?: string | null;
@@ -1484,9 +1474,9 @@ interface ReservationCreated {
     counts?: ReservationCount[];
 }
 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",
@@ -1562,7 +1552,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;
@@ -1571,7 +1561,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;
@@ -1684,7 +1674,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 {
@@ -1815,7 +1805,7 @@ interface TicketReservationQuantity {
      * @format DECIMAL_VALUE
      */
     priceOverride?: string | null;
-    /** Optional ticket details */
+    /** Optional ticket details. */
     ticketDetails?: TicketDetails[];
 }
 interface CreateReservationResponse {
@@ -1945,7 +1935,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;
@@ -1961,7 +1951,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 {
@@ -1992,7 +1982,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;
@@ -2100,7 +2090,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. */
@@ -2149,7 +2139,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;
@@ -2157,7 +2147,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[];
@@ -2179,9 +2169,9 @@ interface GetReservationResponse {
     reservation?: Reservation;
 }
 interface Reservation {
-    /** Date and time the Ticket Reservation was created. */
+    /** Date and time the ticket reservation was created. */
     _createdDate?: Date | null;
-    /** Date and time the Ticket Reservation was last updated. */
+    /** Date and time the ticket reservation was last updated. */
     _updatedDate?: Date | null;
     /** Date and time the pending ticket reservation will expire. */
     expirationDate?: Date | null;
@@ -2297,7 +2287,7 @@ interface OrderDeletedEnvelope {
     metadata: BaseEventMetadata;
 }
 /**
- * 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.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Events - all permissions
@@ -2420,7 +2410,7 @@ interface OrderReservationUpdatedEnvelope {
  * @slug reservation_updated
  */
 declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
-type OrderNonNullablePaths = `orderNumber` | `reservationId` | `snapshotId` | `eventId` | `contactId` | `memberId` | `firstName` | `lastName` | `email` | `checkoutForm.inputValues` | `checkoutForm.inputValues.${number}.inputName` | `checkoutForm.inputValues.${number}.value` | `confirmed` | `status` | `method` | `ticketsQuantity` | `totalPrice.amount` | `totalPrice.currency` | `ticketsPdf` | `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.qrCode` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.ticketPdf` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl` | `archived` | `anonymized` | `fullName` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `fullyCheckedIn` | `paymentDetails.transaction.transactionId` | `paymentDetails.transaction.method` | `channel`;
+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`;
 /**
  * Retrieves a list of orders, including ticket data.
  * @public
@@ -2733,7 +2723,7 @@ declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptio
 declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<NonNullablePaths<ListAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
 interface ListAvailableTicketsOptions {
     /**
-     * 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;
@@ -2884,7 +2874,7 @@ interface CheckoutOptionsForRequest {
      * @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;
@@ -2900,7 +2890,7 @@ interface CheckoutOptionsForRequest {
     paidPlanBenefit?: PaidPlanBenefit;
     /** Options controlling the checkout process. */
     options?: CheckoutOptions;
-    /** Whether marketing consent was given */
+    /** Whether marketing consent was given. */
     marketingConsent?: boolean | null;
 }
 /**
@@ -2935,7 +2925,7 @@ interface UpdateCheckoutOptions {
     /**
      * 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. */
@@ -2965,7 +2955,7 @@ interface PosCheckoutOptions {
     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;