@wix/auto_sdk_events_ticket-definitions 1.0.3 → 1.0.5

package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts

@@ -1,5 +1,8 @@
 export interface TicketDefinition {
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     _id?: string;
     /** Ticket price. */
     price?: Money;
@@ -12,6 +15,7 @@ export interface TicketDefinition {
     /**
      * Limit of tickets that can be purchased per checkout.
      * Set to 20 for unlimited ticket definition.
+     * @max 20
      */
     limitPerCheckout?: number;
     /** Custom sort index. */
@@ -20,7 +24,10 @@ export interface TicketDefinition {
     policy?: string;
     /** Sensitive dashboard data. */
     dashboard?: Dashboard;
-    /** Event ID associated with the ticket. */
+    /**
+     * Event ID associated with the ticket.
+     * @format GUID
+     */
     eventId?: string;
     /**
      * Configuration of the fixed-rate Wix ticket service fee that is applied at checkout to each ticket sold.
@@ -43,15 +50,20 @@ export interface Money {
     /**
      * @internal
      * @internal
+     * @format DECIMAL_VALUE
      * @deprecated
      */
     amount?: string;
     /**
      * Three-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
      */
     currency?: string;
-    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */
+    /**
+     * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
+     * @format DECIMAL_VALUE
+     */
     value?: string | null;
 }
 export interface Dashboard {
@@ -137,9 +149,16 @@ export interface PricingOptions {
     options?: PricingOption[];
 }
 export interface PricingOption {
-    /** Ticket pricing option ID. */
+    /**
+     * Ticket pricing option ID.
+     * @format GUID
+     */
     _id?: string | null;
-    /** Ticket pricing option name. */
+    /**
+     * Ticket pricing option name.
+     * @minLength 1
+     * @maxLength 200
+     */
     name?: string | null;
     /** Ticket pricing option price. */
     price?: Money;
@@ -151,20 +170,29 @@ export declare enum Type {
 export interface QueryTicketDefinitionsRequest {
     /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number;
-    /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     * @max 100
+     */
     limit?: number;
-    /** Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset). */
+    /**
+     * Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset).
+     * @maxSize 20
+     */
     fieldset?: TicketDefinitionFieldset[];
     /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions). */
     filter?: Record<string, any> | null;
     /**
      * Sort order. Defaults to: "created:asc".
      * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
+     * @maxLength 100
      */
     sort?: string;
     /**
      * Filter facets to include in the response.
      * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
+     * @maxLength 20
+     * @maxSize 10
      */
     facet?: string[];
 }
@@ -179,7 +207,10 @@ export interface QueryTicketDefinitionsResponse {
     total?: number;
     /** Offset. */
     offset?: number;
-    /** Limit. */
+    /**
+     * Limit.
+     * @max 100
+     */
     limit?: number;
     /** Ticket definitions. */
     definitions?: TicketDefinition[];
@@ -224,7 +255,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -240,13 +274,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -269,17 +307,30 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface ListTicketDefinitionsRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     * @maxSize 100
+     */
     eventId?: string[];
     /** Offset. */
     offset?: number;
-    /** Paging limit. */
+    /**
+     * Paging limit.
+     * @max 100
+     */
     limit?: number;
     /**
      * Predefined sets of fields to return.
@@ -288,29 +339,41 @@ export interface ListTicketDefinitionsRequest {
      *
      * Default: If `fieldset` is omitted from the request,  `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
      *
+     * @maxSize 20
      */
     fieldset?: TicketDefinitionFieldset[];
-    /** Event creator ID. */
+    /**
+     * Event creator ID.
+     * @format GUID
+     * @maxSize 1
+     */
     eventCreatorId?: string[];
     /**
      * Filter by ticket definition state.
      *
      * Supported values: `"VISIBLE"`, `"HIDDEN"`, `"FREE"`, `"PAID"`
+     * @maxSize 20
      */
     state?: State[];
     /**
      * Sort order.
      *
      * Default: `"created"`:`"asc"`
+     * @maxLength 100
      */
     sort?: string;
     /**
      * Ticket sale status.
      *
      * Supported values: `"SALE_SCHEDULED"`, `"SALE_STARTED"`, `"SALE_ENDED"`
+     * @maxSize 5
      */
     saleStatus?: TicketSaleStatus[];
-    /** Filter facets. */
+    /**
+     * Filter facets.
+     * @maxLength 20
+     * @maxSize 10
+     */
     facet?: string[];
 }
 export declare enum State {
@@ -348,7 +411,10 @@ export interface ResponseMetaData {
     total?: number;
 }
 export interface GetTicketDefinitionRequest {
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     definitionId: string;
     /**
      * Predefined sets of fields to return.
@@ -356,6 +422,7 @@ export interface GetTicketDefinitionRequest {
      * - `POLICY`: Returns `policy`.
      *
      * Default: If `fieldset` is omitted from the request,  `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
+     * @maxSize 20
      */
     fieldset?: TicketDefinitionFieldset[];
 }
@@ -364,17 +431,26 @@ export interface GetTicketDefinitionResponse {
     definition?: TicketDefinition;
 }
 export interface CreateTicketDefinitionRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
     /** Ticket definition data. */
     definition: TicketDefinitionData;
 }
 export interface TicketDefinitionData {
-    /** Ticket name. */
+    /**
+     * Ticket name.
+     * @maxLength 30
+     */
     name?: string | null;
     /** Ticket price. */
     price?: Money;
-    /** Ticket description. */
+    /**
+     * Ticket description.
+     * @maxLength 500
+     */
     description?: string | null;
     /** Whether this ticket type is limited in quantity. */
     limited?: boolean;
@@ -386,7 +462,10 @@ export interface TicketDefinitionData {
     quantity?: number | null;
     /** Custom sort index for manual tickets ordering implementation. */
     orderIndex?: number;
-    /** Policy information in plain text (as listed on the ticket). */
+    /**
+     * Policy information in plain text (as listed on the ticket).
+     * @maxLength 1000
+     */
     policy?: string | null;
     /** Whether this ticket type is hidden to customers and cannot be purchased. */
     hidden?: boolean;
@@ -404,25 +483,46 @@ export interface CreateTicketDefinitionResponse {
 export interface TicketDefinitionCreated {
     /** Ticket Definition created timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Ticket Definition ID. */
+    /**
+     * Ticket Definition ID.
+     * @format GUID
+     */
     ticketDefinitionId?: string;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Originated from. */
     originatedFrom?: OriginatedFrom;
 }
 export interface OriginatedFrom {
-    /** Instance ID. Indicates the original app instance which current entity originated from. */
+    /**
+     * Instance ID. Indicates the original app instance which current entity originated from.
+     * @format GUID
+     */
     instanceId?: string;
-    /** Event ID. Indicates the original event which current entity originated from. */
+    /**
+     * Event ID. Indicates the original event which current entity originated from.
+     * @format GUID
+     */
     eventId?: string;
-    /** Event ID. Indicates the original entity which current entity originated from. */
+    /**
+     * Event ID. Indicates the original entity which current entity originated from.
+     * @format GUID
+     */
     entityId?: string;
 }
 export interface UpdateTicketDefinitionRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     definitionId: string;
     /** Ticket definition data. */
     definition?: TicketDefinitionData;
@@ -436,9 +536,15 @@ export interface UpdateTicketDefinitionResponse {
 export interface TicketDefinitionUpdated {
     /** Ticket definition updated timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     ticketDefinitionId?: string;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
@@ -446,7 +552,10 @@ export interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionReq
     byId?: ById;
     /** Whether to delete all event tickets. */
     all?: boolean;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
 }
 /** @oneof */
@@ -457,7 +566,12 @@ export interface DeleteTicketDefinitionRequestDeleteOneOf {
     all?: boolean;
 }
 export interface ById {
-    /** Ticket definition IDs. */
+    /**
+     * Ticket definition IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     definitionId?: string[];
 }
 export interface DeleteTicketDefinitionResponse {
@@ -465,15 +579,28 @@ export interface DeleteTicketDefinitionResponse {
 export interface TicketDefinitionDeleted {
     /** Ticket definition deleted timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     ticketDefinitionId?: string;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface ChangeCurrencyRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
-    /** Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    /**
+     * Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @minLength 3
+     * @maxLength 3
+     */
     currency: string;
 }
 export interface ChangeCurrencyResponse {
@@ -481,9 +608,15 @@ export interface ChangeCurrencyResponse {
 export interface BulkCopyTicketDefinitionsByEventIdRequest {
     /** Origin instance ID. */
     originInstanceId?: string | null;
-    /** Origin Event ID. */
+    /**
+     * Origin Event ID.
+     * @format GUID
+     */
     originEventId?: string;
-    /** Target Event ID. */
+    /**
+     * Target Event ID.
+     * @format GUID
+     */
     targetEventId?: string;
 }
 export interface BulkCopyTicketDefinitionsByEventIdResponse {
@@ -503,9 +636,15 @@ export interface PaidTicketDefinitionExistsResponse {
     paidExists?: boolean;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -513,26 +652,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -616,9 +779,15 @@ export interface UpdateTicketDefinitionResponseNonNullableFields {
     definition?: TicketDefinitionNonNullableFields;
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -712,20 +881,29 @@ export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsO
 export interface QueryTicketDefinitionsOptions {
     /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number;
-    /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     * @max 100
+     */
     limit?: number;
-    /** Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset). */
+    /**
+     * Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset).
+     * @maxSize 20
+     */
     fieldset?: TicketDefinitionFieldset[];
     /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions). */
     filter?: Record<string, any> | null;
     /**
      * Sort order. Defaults to: "created:asc".
      * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
+     * @maxLength 100
      */
     sort?: string;
     /**
      * Filter facets to include in the response.
      * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
+     * @maxLength 20
+     * @maxSize 10
      */
     facet?: string[];
 }
@@ -817,11 +995,18 @@ export interface DefinitionsQueryBuilder {
  */
 export declare function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise<ListTicketDefinitionsResponse & ListTicketDefinitionsResponseNonNullableFields>;
 export interface ListTicketDefinitionsOptions {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     * @maxSize 100
+     */
     eventId?: string[];
     /** Offset. */
     offset?: number;
-    /** Paging limit. */
+    /**
+     * Paging limit.
+     * @max 100
+     */
     limit?: number;
     /**
      * Predefined sets of fields to return.
@@ -829,14 +1014,20 @@ export interface ListTicketDefinitionsOptions {
      * - `POLICY`: Returns `policy`.
      *
      * Default: If `fieldset` is omitted from the request,  `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
+     * @maxSize 20
      */
     fieldset?: TicketDefinitionFieldset[];
-    /** Event creator ID. */
+    /**
+     * Event creator ID.
+     * @format GUID
+     * @maxSize 1
+     */
     eventCreatorId?: string[];
     /**
      * Filter by ticket definition state.
      *
      * Supported values: `"VISIBLE"`, `"HIDDEN"`, `"FREE"`, `"PAID"`
+     * @maxSize 20
      */
     state?: State[];
     /**
@@ -849,15 +1040,21 @@ export interface ListTicketDefinitionsOptions {
      *
      *
      *
+     * @maxLength 100
      */
     sort?: string;
     /**
      * Ticket sale status.
      *
      * Supported values: `"SALE_SCHEDULED"`, `"SALE_STARTED"`, `"SALE_ENDED"`
+     * @maxSize 5
      */
     saleStatus?: TicketSaleStatus[];
-    /** Filter facets. */
+    /**
+     * Filter facets.
+     * @maxLength 20
+     * @maxSize 10
+     */
     facet?: string[];
 }
 /**
@@ -900,6 +1097,7 @@ export interface GetTicketDefinitionOptions {
      * - `POLICY`: Returns `policy`.
      *
      * Default: If `fieldset` is omitted from the request,  `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
+     * @maxSize 20
      */
     fieldset?: TicketDefinitionFieldset[];
 }
@@ -1012,7 +1210,14 @@ export interface UpdateTicketDefinitionOptions {
  * @targetRemovalDate 2024-12-01
  */
 export declare function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise<void>;
-export interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionRequestDeleteOneOf {
+export interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
+    /** Ticket definitions to delete. */
+    byId?: ById;
+    /** Whether to delete all event tickets. */
+    all?: boolean;
+}
+/** @oneof */
+export interface DeleteTicketDefinitionOptionsDeleteOneOf {
     /** Ticket definitions to delete. */
     byId?: ById;
     /** Whether to delete all event tickets. */
@@ -1048,9 +1253,16 @@ export interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionReq
  */
 export declare function changeCurrency(options?: ChangeCurrencyOptions): Promise<void>;
 export interface ChangeCurrencyOptions {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
-    /** Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    /**
+     * Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @minLength 3
+     * @maxLength 3
+     */
     currency: string;
 }
 export {};