@wix/auto_sdk_events_ticket-definitions-v-2 1.0.36 → 1.0.37

package/build/es/index.typings.d.mts

@@ -14,17 +14,17 @@ interface TicketDefinition {
      */
     eventId?: string | null;
     /**
-     * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
+     * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing `revision` must be used when updating a ticket definition.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time when the ticket definition was created.
+     * Date and time the ticket definition was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the ticket definition was updated.
+     * Date and time the ticket definition was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -44,7 +44,7 @@ interface TicketDefinition {
      * @maxLength 1000
      */
     policyText?: string | null;
-    /** Whether this ticket definition is hidden to site visitors and can't be purchased. */
+    /** Whether this ticket definition is hidden from site visitors and can't be purchased. */
     hidden?: boolean;
     /**
      * Whether the ticket has a limited maximum quantity.
@@ -60,7 +60,7 @@ interface TicketDefinition {
     actualLimit?: number | null;
     /** Ticket pricing method. */
     pricingMethod?: PricingMethod;
-    /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
+    /** Type of ticket service fee to collect. */
     feeType?: FeeTypeEnumTypeWithLiterals;
     /** Ticket sale period. */
     salePeriod?: SalePeriod;
@@ -70,13 +70,13 @@ interface TicketDefinition {
      */
     saleStatus?: SaleStatusEnumStatusWithLiterals;
     /**
-     * Ticket sales information. <br>
-     * **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.
+     * Ticket sales information. <br> <br>
+     * **Note:** This field is only returned when `"SALES_DETAILS"` is specified in `field` in the request.
      */
     salesDetails?: SalesDetails;
     /**
-     * Number of tickets that can be purchased per checkout. <br>
-     * **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
+     * Number of tickets that can be purchased per checkout. <br> <br>
+     * **Note:** If the `actualLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
      * @readonly
      * @max 50
      */
@@ -84,15 +84,15 @@ interface TicketDefinition {
     /** Data extensions. */
     extendedFields?: ExtendedFields;
     /**
-     * Associated event information. <br>
-     * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.
+     * Information about the even the ticket is for. <br>
+     * **Note:** This field is only returned when `"EVENT_DETAILS"` is specified in `field` in the request.
      */
     eventDetails?: EventDetails;
 }
 interface SalePeriod {
-    /** Ticket sale start timestamp. */
+    /** Date and time the ticket sale starts. */
     startDate?: Date | null;
-    /** Ticket sale end timestamp. */
+    /** Date and time the ticket sale ends. */
     endDate?: Date | null;
     /** Whether to display the ticket if it's not available to buy. */
     displayNotOnSale?: boolean;
@@ -100,7 +100,7 @@ interface SalePeriod {
 interface PricingMethod extends PricingMethodPriceOneOf {
     /** Same ticket price for everyone. */
     fixedPrice?: CommonMoney;
-    /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). The price can be updated to a higher amount by a guest during the checkout. */
+    /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or specify `"0"` in the request to make the ticket free. The price can be updated to a higher amount by a guest during the checkout. */
     guestPrice?: CommonMoney;
     /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
     pricingOptions?: PricingOptions;
@@ -110,7 +110,7 @@ interface PricingMethod extends PricingMethodPriceOneOf {
      */
     pricingType?: PricingTypeEnumTypeWithLiterals;
     /**
-     * Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.
+     * Whether the ticket is free. To create a free ticket, enter `"0"` in `pricingMethod.fixedPrice.value`.
      * @readonly
      */
     free?: boolean;
@@ -119,7 +119,7 @@ interface PricingMethod extends PricingMethodPriceOneOf {
 interface PricingMethodPriceOneOf {
     /** Same ticket price for everyone. */
     fixedPrice?: CommonMoney;
-    /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). The price can be updated to a higher amount by a guest during the checkout. */
+    /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or specify `"0"` in the request to make the ticket free. The price can be updated to a higher amount by a guest during the checkout. */
     guestPrice?: CommonMoney;
     /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
     pricingOptions?: PricingOptions;
@@ -142,7 +142,7 @@ interface CommonMoney {
 }
 interface PricingOptions {
     /**
-     * Ticket price option details.
+     * Ticket price options.
      * @maxSize 100
      */
     optionDetails?: OptionDetails[];
@@ -175,11 +175,11 @@ type PricingTypeEnumTypeWithLiterals = PricingTypeEnumType | 'UNKNOWN_PRICING_TY
 declare enum FeeTypeEnumType {
     /** Unknown fee type. */
     UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
-    /** The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a ticket service fee of $0.25 will be deducted from the price and you'll get $9.75. */
+    /** The fee is deducted from the ticket price for a seller. <br><br> For example, if you're selling tickets for $10, then a ticket service fee of $0.25 will be deducted from the price and you'll get $9.75. */
     FEE_INCLUDED = "FEE_INCLUDED",
-    /** The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a ticket service fee of $0.25 and will pay $10.25 in total. */
+    /** The fee is shown in addition to the ticket price at checkout and a guest pays the fee. <br><br> For example, if you sell tickets for $10, a customer will see a ticket service fee of $0.25 and will pay $10.25 in total. */
     FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
-    /** Ticket service fee is not collected. Available only for free tickets and legacy users. */
+    /** Ticket service fee isn't collected. Available only for free tickets and legacy Wix users. */
     NO_FEE = "NO_FEE"
 }
 /** @enumType */
@@ -187,18 +187,18 @@ type FeeTypeEnumTypeWithLiterals = FeeTypeEnumType | 'UNKNOWN_FEE_TYPE' | 'FEE_I
 declare enum SaleStatusEnumStatus {
     /** Undefined sale status. */
     UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
-    /** Tickets are not on sale yet. */
+    /** Tickets aren't on sale yet. */
     SALE_SCHEDULED = "SALE_SCHEDULED",
     /** Tickets are on sale. */
     SALE_STARTED = "SALE_STARTED",
-    /** Tickets are not on sale. */
+    /** Tickets are no longer on sale. */
     SALE_ENDED = "SALE_ENDED"
 }
 /** @enumType */
 type SaleStatusEnumStatusWithLiterals = SaleStatusEnumStatus | 'UNKNOWN_SALE_STATUS' | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
 interface SalesDetails {
     /**
-     * Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.
+     * Number of tickets that haven't been purchased yet. The field is `null` if the ticket quantity is unlimited.
      * @readonly
      */
     unsoldCount?: number | null;
@@ -238,7 +238,7 @@ interface EventDetails {
      */
     title?: string | null;
     /**
-     * Event short description.
+     * Short description of the event.
      * @maxLength 500
      * @readonly
      */
@@ -249,7 +249,7 @@ interface EventDetails {
      */
     location?: Location;
     /**
-     * Event date  and time settings.
+     * Event date and time settings.
      * @readonly
      */
     dateAndTimeSettings?: DateAndTimeSettings;
@@ -768,7 +768,7 @@ interface UpdateTicketDefinitionSortIndexResponse {
     ticketDefinition?: TicketDefinition;
 }
 interface QueryTicketDefinitionsRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     query: QueryV2;
     /**
      * Predefined sets of fields to return.
@@ -863,7 +863,7 @@ interface Cursors {
     prev?: string | null;
 }
 interface QueryAvailableTicketDefinitionsRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     query: QueryV2;
     /**
      * Predefined sets of fields to return.
@@ -962,7 +962,7 @@ interface CopiedTicketDefinition {
     ticketDefinitionId?: string;
 }
 interface UpdateFeeTypesBasedOnSettingsRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     query?: QueryV2;
 }
 interface UpdateFeeTypesBasedOnSettingsResponse {
@@ -1519,7 +1519,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;
@@ -4335,7 +4335,7 @@ interface EventTicketingSummary {
      */
     _updatedDate?: Date | null;
     /**
-     * Whether all tickets are sold for this event.
+     * Whether all tickets are sold out for this event.
      * @readonly
      */
     soldOut?: boolean | null;
@@ -4402,9 +4402,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",
@@ -4600,7 +4600,7 @@ interface TicketDefinitionSaleEndedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when a ticket sale ends. Sales details are not included in the payload.
+ * Triggered when a ticket sale ends. Sales details aren't included in the response.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -4640,7 +4640,7 @@ interface TicketDefinitionSaleStartedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when a ticket sale starts. Sales details are not included in the payload.
+ * Triggered when a ticket sale starts. Sales details aren't included in the response.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -4679,8 +4679,7 @@ type TicketDefinitionNonNullablePaths = `hidden` | `limited` | `pricingMethod.fi
 /**
  * Creates a ticket definition.
  *
- *
- * It is allowed to create up to 100 definitions per event.
+ * You may create up to 100 definitions per event.
  * @param ticketDefinition - Ticket definition info.
  * @public
  * @requiredField ticketDefinition
@@ -4688,7 +4687,7 @@ type TicketDefinitionNonNullablePaths = `hidden` | `limited` | `pricingMethod.fi
  * @requiredField ticketDefinition.feeType
  * @requiredField ticketDefinition.name
  * @requiredField ticketDefinition.pricingMethod
- * @param options - Optional fields.
+ * @param options - Currency info.
  * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
  * @applicableIdentity APP
  * @returns Created ticket definition.
@@ -4707,7 +4706,6 @@ interface CreateTicketDefinitionOptions {
 /**
  * Updates a ticket definition.
  *
- *
  * Each time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.
  * @param _id - Ticket definition ID.
  * @public
@@ -4738,17 +4736,17 @@ interface UpdateTicketDefinition {
      */
     eventId?: string | null;
     /**
-     * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
+     * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing `revision` must be used when updating a ticket definition.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time when the ticket definition was created.
+     * Date and time the ticket definition was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the ticket definition was updated.
+     * Date and time the ticket definition was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -4768,7 +4766,7 @@ interface UpdateTicketDefinition {
      * @maxLength 1000
      */
     policyText?: string | null;
-    /** Whether this ticket definition is hidden to site visitors and can't be purchased. */
+    /** Whether this ticket definition is hidden from site visitors and can't be purchased. */
     hidden?: boolean;
     /**
      * Whether the ticket has a limited maximum quantity.
@@ -4784,7 +4782,7 @@ interface UpdateTicketDefinition {
     actualLimit?: number | null;
     /** Ticket pricing method. */
     pricingMethod?: PricingMethod;
-    /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
+    /** Type of ticket service fee to collect. */
     feeType?: FeeTypeEnumTypeWithLiterals;
     /** Ticket sale period. */
     salePeriod?: SalePeriod;
@@ -4794,13 +4792,13 @@ interface UpdateTicketDefinition {
      */
     saleStatus?: SaleStatusEnumStatusWithLiterals;
     /**
-     * Ticket sales information. <br>
-     * **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.
+     * Ticket sales information. <br> <br>
+     * **Note:** This field is only returned when `"SALES_DETAILS"` is specified in `field` in the request.
      */
     salesDetails?: SalesDetails;
     /**
-     * Number of tickets that can be purchased per checkout. <br>
-     * **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
+     * Number of tickets that can be purchased per checkout. <br> <br>
+     * **Note:** If the `actualLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
      * @readonly
      * @max 50
      */
@@ -4808,8 +4806,8 @@ interface UpdateTicketDefinition {
     /** Data extensions. */
     extendedFields?: ExtendedFields;
     /**
-     * Associated event information. <br>
-     * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.
+     * Information about the even the ticket is for. <br>
+     * **Note:** This field is only returned when `"EVENT_DETAILS"` is specified in `field` in the request.
      */
     eventDetails?: EventDetails;
 }
@@ -4821,7 +4819,7 @@ interface UpdateTicketDefinitionOptions {
     fields?: FieldWithLiterals[];
 }
 /**
- * Retrieves a ticket definition by ID.
+ * Retrieves a ticket definition.
  * @param ticketDefinitionId - Ticket definition ID.
  * @public
  * @requiredField ticketDefinitionId
@@ -4840,7 +4838,7 @@ interface GetTicketDefinitionOptions {
     fields?: FieldWithLiterals[];
 }
 /**
- * Permanently deletes a ticket definition.
+ * Deletes a ticket definition.
  * @param ticketDefinitionId - ID of the ticket definition to delete.
  * @public
  * @requiredField ticketDefinitionId
@@ -4850,8 +4848,8 @@ interface GetTicketDefinitionOptions {
  */
 declare function deleteTicketDefinition(ticketDefinitionId: string): Promise<void>;
 /**
- * Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.
- * > **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed.
+ * Adjusts the order in which ticket definitions display in an event dashboard, as well as the order of available tickets displayed in the ticket picker.
+ * > **Note:** You may use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` but only the last one provided takes effect.
  * @param eventId - Event ID.
  * @public
  * @requiredField eventId
@@ -4965,9 +4963,9 @@ interface TicketDefinitionsQueryBuilder {
     find: () => Promise<TicketDefinitionsQueryResult>;
 }
 /**
- * Retrieves a list of available ticket definitions, given the provided paging, filtering, and sorting.
+ * Retrieves a list of available ticket definitions with the specified paging, filtering, and sorting.
  *
- * This endpoint retrieves ticket definitions that aren't in the `hidden` state. The available ticket definitions can be retrieved by site visitors.
+ * This method retrieves ticket definitions that aren't in the `hidden` state. The available ticket definitions can be retrieved by site visitors.
  *
  * > **Note:** You need the `WIX_EVENTS.READ_TICKET_DEFINITIONS` permission to get the `salesDetails` field values.
  *
@@ -4977,8 +4975,8 @@ interface TicketDefinitionsQueryBuilder {
  * - `paging.offset` is `0`
  *
  * For field support for filters and sorting, see [Ticket Definitions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/filter-and-sort).
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
- * @param query - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
+ * To learn about working with _Query_ methods, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
+ * @param query - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details.
  * @public
  * @requiredField query
  * @param options - Optional fields.