@wix/auto_sdk_events_orders 1.0.24 → 1.0.25

package/build/internal/es/meta.d.mts

@@ -22,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;
@@ -32,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;
@@ -41,7 +41,7 @@ interface Order {
     /** Guest last name. */
     lastName?: string;
     /**
-     * Guest email.
+     * Guest email address.
      * @format EMAIL
      */
     email?: string;
@@ -51,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;
@@ -69,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;
@@ -85,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",
@@ -117,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",
@@ -142,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;
@@ -153,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;
@@ -171,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. */
@@ -193,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
@@ -223,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
      */
@@ -235,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 {
@@ -264,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"
@@ -344,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;
@@ -354,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;
@@ -512,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 {
@@ -523,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;
@@ -809,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",
@@ -829,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;
@@ -838,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;
@@ -953,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 {
@@ -1085,7 +1075,7 @@ interface TicketReservationQuantity {
      * @format DECIMAL_VALUE
      */
     priceOverride?: string | null;
-    /** Optional ticket details */
+    /** Optional ticket details. */
     ticketDetails?: TicketDetails[];
 }
 interface CreateReservationResponse {
@@ -1195,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;
@@ -1211,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 {
@@ -1242,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;
@@ -1281,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. */
@@ -1308,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;
@@ -1316,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_events_orders",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -49,5 +49,5 @@
       "fqdn": "wix.events.v1.order"
     }
   },
-  "falconPackageHash": "9f43d411af56e167a5df12706f2aaab51cb62d4afdb3fb4ba96eb443"
+  "falconPackageHash": "ac79a35c8fb9276a0f1e0d80960f880093ee18f3fc97381e1ce357fa"
 }