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

package/build/cjs/index.d.ts

@@ -1,20 +1,20 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { TicketDefinition, CreateTicketDefinitionOptions, CreateTicketDefinitionApplicationErrors, UpdateTicketDefinition, UpdateTicketDefinitionOptions, UpdateTicketDefinitionApplicationErrors, GetTicketDefinitionOptions, ReorderTicketDefinitionsOptions, ReorderTicketDefinitionsApplicationErrors, QueryTicketDefinitionsOptions, TicketDefinitionsQueryBuilder, QueryV2, QueryAvailableTicketDefinitionsOptions, QueryAvailableTicketDefinitionsResponse, CountTicketDefinitionsOptions, CountTicketDefinitionsResponse, CountTicketDefinitionsApplicationErrors, CountAvailableTicketDefinitionsOptions, CountAvailableTicketDefinitionsResponse, CountAvailableTicketDefinitionsApplicationErrors, ChangeCurrencyOptions, ChangeCurrencyApplicationErrors, TicketDefinitionCreatedEnvelope, TicketDefinitionDeletedEnvelope, TicketDefinitionSaleEndedEnvelope, TicketDefinitionSalePeriodUpdatedEnvelope, TicketDefinitionSaleStartedEnvelope, TicketDefinitionUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, Address, AddressLocation, AddressStreetOneOf, Agenda, Alignment, AnchorData, App, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, Asset, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, Badge, BaseEventMetadata, BlockquoteData, BookingData, Border, BorderColors, BulkCopyTicketDefinitionsByEventIdRequest, BulkCopyTicketDefinitionsByEventIdResponse, BulkDeleteTicketDefinitionsByFilterRequest, BulkDeleteTicketDefinitionsByFilterResponse, BulletedListData, ButtonData, ButtonDataType, CalendarLinks, CaptionData, Category, CategoryCounts, CategoryDetails, CategoryStateState, CellStyle, ChangeCurrencyRequest, ChangeCurrencyResponse, CheckoutFormMessages, CodeBlockData, CollapsibleListData, ColorData, Colors, CommonAddress, CommonAddressLocation, CommonAddressStreetOneOf, CommonMoney, CommonStreetAddress, CommonSubdivision, ConferenceType, CopiedTicketDefinition, CountAvailableTicketDefinitionsRequest, CountTicketDefinitionsRequest, CreateTicketDefinitionRequest, CreateTicketDefinitionResponse, Crop, CursorPaging, Cursors, CustomTag, Dashboard, DateAndTimeSettings, Decoration, DecorationDataOneOf, DecorationType, DeleteContext, DeleteStatus, DeleteTicketDefinitionRequest, DeleteTicketDefinitionResponse, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Event, EventCanceled, EventCreated, EventData, EventDeleted, EventDetails, EventDisplaySettings, EventEnded, EventMetadata, EventStatus, EventTicketingSummary, EventType, EventUpdated, EventsLocation, EventsOccurrence, EventsRecurrenceStatusStatus, EventsRecurrences, ExtendedFields, ExternalEvent, FacetCounts, FeeTypeEnumType, Feed, Field, File, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, Form, FormMessages, Formatted, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetTicketDefinitionFromTrashBinRequest, GetTicketDefinitionFromTrashBinResponse, GetTicketDefinitionRequest, GetTicketDefinitionResponse, GetTicketDefinitionSummaryRequest, GetTicketDefinitionSummaryResponse, Gradient, GuestListConfig, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, Input, InputControl, InputControlType, InvalidateCache, InvalidateCacheGetByOneOf, Item, ItemDataOneOf, ItemStyle, Keyword, Label, LabellingSettings, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListEventTicketingSummaryRequest, ListEventTicketingSummaryResponse, ListValue, Location, LocationLocationType, LocationType, MapCoordinates, MapData, MapSettings, MapType, Media, MentionData, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Metadata, Money, Namespace, NamespaceChanged, Negative, NegativeResponseConfirmation, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Occurrence, OdeditorAssigned, OdeditorUnassigned, Oembed, OnlineConferencing, OnlineConferencingConfig, OnlineConferencingSession, Option, OptionDesign, OptionDetails, OptionLayout, OptionSelection, OptionSelectionSelectedOptionOneOf, OrderedListData, Orientation, PDFSettings, Page, Paging, PagingMetadataV2, ParagraphData, Permissions, PicassoAssigned, PicassoUnassigned, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Positive, PositiveResponseConfirmation, PricingMethod, PricingMethodPriceOneOf, PricingOptions, PricingTypeEnumType, QueryAvailableTicketDefinitionsRequest, QueryTicketDefinitionsRequest, QueryTicketDefinitionsResponse, QueryV2PagingMethodOneOf, RecurrenceStatusStatus, Recurrences, Registration, RegistrationClosedMessages, RegistrationStatus, Rel, ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf, ReorderTicketDefinitionsRequest, ReorderTicketDefinitionsRequestReferenceDefinitionOneOf, ReorderTicketDefinitionsResponse, ReservationCount, ReservationCreated, ReservationStatus, ReservationUpdated, ResponseConfirmation, RestoreInfo, RichContent, RsvpCollection, RsvpCollectionConfig, RsvpFormMessages, RsvpStatusOptions, RsvpSummary, SalePeriod, SalePeriodUpdated, SaleStatusEnumStatus, SalesDetails, ScheduleConfig, ScheduleLegacyTimeCapsuleTaskRequest, Scheduling, SeatingPlanCategoriesSummaryUpdated, SeoSchema, SeoSettings, ServiceProvisioned, ServiceRemoved, Settings, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrl, SiteUrlChanged, SortOrder, Sorting, Source, Spoiler, SpoilerData, State, Status, StreetAddress, StudioAssigned, StudioUnassigned, Styles, StylesBorder, Subdivision, SubdivisionSubdivisionType, SubdivisionType, TableCellData, TableData, Tag, Target, TaxConfig, TaxType, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, TicketDefinitionSaleEnded, TicketDefinitionSaleStarted, TicketDefinitionSummary, TicketDefinitionsQueryResult, TicketQuantity, Ticketing, TicketingConfig, TicketingSummary, TicketsUnavailableMessages, Type, URI, UpdateFeeTypesBasedOnSettingsRequest, UpdateFeeTypesBasedOnSettingsResponse, UpdateTicketDefinitionRequest, UpdateTicketDefinitionResponse, UpdateTicketDefinitionSortIndexRequest, UpdateTicketDefinitionSortIndexResponse, ValueType, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VisitorType, VoteRole, WebhookIdentityType, Width, WidthType } from './index.typings.js';
 
+type TicketDefinitionNonNullablePaths = `hidden` | `limited` | `pricingMethod.fixedPrice.value` | `pricingMethod.fixedPrice.currency` | `pricingMethod.pricingOptions.optionDetails` | `pricingMethod.pricingType` | `pricingMethod.free` | `feeType` | `salePeriod.displayNotOnSale` | `saleStatus` | `eventDetails.location.type` | `eventDetails.location.address.streetAddress.number` | `eventDetails.location.address.streetAddress.name` | `eventDetails.dateAndTimeSettings.recurrenceStatus` | `eventDetails.dateAndTimeSettings.recurringEvents.individualEventDates` | `eventDetails.dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `eventDetails.status`;
 declare function createTicketDefinition$1(httpClient: HttpClient): CreateTicketDefinitionSignature;
 interface CreateTicketDefinitionSignature {
     /**
      * 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 - Ticket definition info.
-     * @param - Optional fields.
+     * @param - Currency info.
      * @returns Created ticket definition.
      */
-    (ticketDefinition: TicketDefinition, options?: CreateTicketDefinitionOptions | undefined): Promise<TicketDefinition & {
-        __applicationErrorsType?: CreateTicketDefinitionApplicationErrors | undefined;
+    (ticketDefinition: NonNullablePaths<TicketDefinition, `eventId` | `feeType` | `name` | `pricingMethod`>, options?: CreateTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths> & {
+        __applicationErrorsType?: CreateTicketDefinitionApplicationErrors;
     }>;
 }
 declare function updateTicketDefinition$1(httpClient: HttpClient): UpdateTicketDefinitionSignature;
@@ -22,31 +22,30 @@ interface UpdateTicketDefinitionSignature {
     /**
      * 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 - Ticket definition ID.
      * @param - Optional fields.
      * @param - Ticket definition to update.
      * @returns The updated ticket definition.
      */
-    (_id: string, ticketDefinition: UpdateTicketDefinition, options?: UpdateTicketDefinitionOptions | undefined): Promise<TicketDefinition & {
-        __applicationErrorsType?: UpdateTicketDefinitionApplicationErrors | undefined;
+    (_id: string, ticketDefinition: NonNullablePaths<UpdateTicketDefinition, `revision`>, options?: UpdateTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths> & {
+        __applicationErrorsType?: UpdateTicketDefinitionApplicationErrors;
     }>;
 }
 declare function getTicketDefinition$1(httpClient: HttpClient): GetTicketDefinitionSignature;
 interface GetTicketDefinitionSignature {
     /**
-     * Retrieves a ticket definition by ID.
+     * Retrieves a ticket definition.
      * @param - Ticket definition ID.
      * @param - Optional fields.
      * @returns The requested ticket definition.
      */
-    (ticketDefinitionId: string, options?: GetTicketDefinitionOptions | undefined): Promise<TicketDefinition>;
+    (ticketDefinitionId: string, options?: GetTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
 }
 declare function deleteTicketDefinition$1(httpClient: HttpClient): DeleteTicketDefinitionSignature;
 interface DeleteTicketDefinitionSignature {
     /**
-     * Permanently deletes a ticket definition.
+     * Deletes a ticket definition.
      * @param - ID of the ticket definition to delete.
      */
     (ticketDefinitionId: string): Promise<void>;
@@ -54,13 +53,13 @@ interface DeleteTicketDefinitionSignature {
 declare function reorderTicketDefinitions$1(httpClient: HttpClient): ReorderTicketDefinitionsSignature;
 interface ReorderTicketDefinitionsSignature {
     /**
-     * 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 - Event ID.
      * @param - Optional fields.
      */
-    (eventId: string, options?: ReorderTicketDefinitionsOptions | undefined): Promise<void & {
-        __applicationErrorsType?: ReorderTicketDefinitionsApplicationErrors | undefined;
+    (eventId: string, options?: NonNullablePaths<ReorderTicketDefinitionsOptions, `ticketDefinitionId`>): Promise<void & {
+        __applicationErrorsType?: ReorderTicketDefinitionsApplicationErrors;
     }>;
 }
 declare function queryTicketDefinitions$1(httpClient: HttpClient): QueryTicketDefinitionsSignature;
@@ -73,14 +72,14 @@ interface QueryTicketDefinitionsSignature {
      * - `paging.offset` is `0`
      * @param - Optional fields.
      */
-    (options?: QueryTicketDefinitionsOptions | undefined): TicketDefinitionsQueryBuilder;
+    (options?: QueryTicketDefinitionsOptions): TicketDefinitionsQueryBuilder;
 }
 declare function queryAvailableTicketDefinitions$1(httpClient: HttpClient): QueryAvailableTicketDefinitionsSignature;
 interface QueryAvailableTicketDefinitionsSignature {
     /**
-     * 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.
      *
@@ -90,11 +89,13 @@ interface QueryAvailableTicketDefinitionsSignature {
      * - `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 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 options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details.
      * @param - Optional fields.
      */
-    (query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions | undefined): Promise<QueryAvailableTicketDefinitionsResponse>;
+    (query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions): Promise<NonNullablePaths<QueryAvailableTicketDefinitionsResponse, {
+        [P in TicketDefinitionNonNullablePaths]: `ticketDefinitions.${number}.${P}`;
+    }[TicketDefinitionNonNullablePaths]>>;
 }
 declare function countTicketDefinitions$1(httpClient: HttpClient): CountTicketDefinitionsSignature;
 interface CountTicketDefinitionsSignature {
@@ -102,8 +103,8 @@ interface CountTicketDefinitionsSignature {
      * Counts ticket definitions by the `saleStatus` field, including those with the `hidden` status.
      * @param - Optional fields.
      */
-    (options?: CountTicketDefinitionsOptions | undefined): Promise<CountTicketDefinitionsResponse & {
-        __applicationErrorsType?: CountTicketDefinitionsApplicationErrors | undefined;
+    (options?: CountTicketDefinitionsOptions): Promise<CountTicketDefinitionsResponse & {
+        __applicationErrorsType?: CountTicketDefinitionsApplicationErrors;
     }>;
 }
 declare function countAvailableTicketDefinitions$1(httpClient: HttpClient): CountAvailableTicketDefinitionsSignature;
@@ -112,8 +113,8 @@ interface CountAvailableTicketDefinitionsSignature {
      * Counts ticket definitions by the `saleStatus`, excluding those with the `hidden` status.
      * @param - Optional fields.
      */
-    (options?: CountAvailableTicketDefinitionsOptions | undefined): Promise<CountAvailableTicketDefinitionsResponse & {
-        __applicationErrorsType?: CountAvailableTicketDefinitionsApplicationErrors | undefined;
+    (options?: CountAvailableTicketDefinitionsOptions): Promise<CountAvailableTicketDefinitionsResponse & {
+        __applicationErrorsType?: CountAvailableTicketDefinitionsApplicationErrors;
     }>;
 }
 declare function bulkDeleteTicketDefinitionsByFilter$1(httpClient: HttpClient): BulkDeleteTicketDefinitionsByFilterSignature;
@@ -133,8 +134,8 @@ interface ChangeCurrencySignature {
      * @param - Event ID.
      * @param - Optional fields.
      */
-    (eventId: string, options: ChangeCurrencyOptions): Promise<void & {
-        __applicationErrorsType?: ChangeCurrencyApplicationErrors | undefined;
+    (eventId: string, options: NonNullablePaths<ChangeCurrencyOptions, `currency`>): Promise<void & {
+        __applicationErrorsType?: ChangeCurrencyApplicationErrors;
     }>;
 }
 declare const onTicketDefinitionCreated$1: EventDefinition<TicketDefinitionCreatedEnvelope, "wix.events.v3.ticket_definition_created">;
@@ -164,7 +165,7 @@ declare const onTicketDefinitionCreated: BuildEventDefinition<typeof onTicketDef
  */
 declare const onTicketDefinitionDeleted: BuildEventDefinition<typeof onTicketDefinitionDeleted$1>;
 /**
- * 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.
  */
 declare const onTicketDefinitionSaleEnded: BuildEventDefinition<typeof onTicketDefinitionSaleEnded$1>;
 /**
@@ -172,7 +173,7 @@ declare const onTicketDefinitionSaleEnded: BuildEventDefinition<typeof onTicketD
  */
 declare const onTicketDefinitionSalePeriodUpdated: BuildEventDefinition<typeof onTicketDefinitionSalePeriodUpdated$1>;
 /**
- * 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.
  */
 declare const onTicketDefinitionSaleStarted: BuildEventDefinition<typeof onTicketDefinitionSaleStarted$1>;
 /**