@wix/auto_sdk_events_ticket-definitions 1.0.2 → 1.0.4

package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.types.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 service fee that is applied at checkout to each ticket sold.
@@ -42,12 +49,19 @@ export interface TicketDefinition {
 export interface Money {
     /**
      * *Deprecated:** Use `value` instead.
+     * @format DECIMAL_VALUE
      * @deprecated
      */
     amount?: string;
-    /** ISO 4217 format of the currency e.g., `USD`. */
+    /**
+     * ISO 4217 format of the currency e.g., `USD`.
+     * @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 {
@@ -127,9 +141,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;
@@ -141,20 +162,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[];
 }
@@ -169,7 +199,10 @@ export interface QueryTicketDefinitionsResponse {
     total?: number;
     /** Offset. */
     offset?: number;
-    /** Limit. */
+    /**
+     * Limit.
+     * @max 100
+     */
     limit?: number;
     /** Ticket definitions. */
     definitions?: TicketDefinition[];
@@ -214,7 +247,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;
@@ -230,13 +266,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;
 }
@@ -259,34 +299,63 @@ 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. 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[];
-    /** Event creator id filter, by default any. */
+    /**
+     * Event creator id filter, by default any.
+     * @format GUID
+     * @maxSize 1
+     */
     eventCreatorId?: string[];
-    /** Filters by ticket definition state. */
+    /**
+     * Filters by ticket definition state.
+     * @maxSize 20
+     */
     state?: State[];
     /**
      * 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_list-ticket-definitions).
+     * @maxLength 100
      */
     sort?: string;
-    /** Ticket sale status. */
+    /**
+     * Ticket sale status.
+     * @maxSize 5
+     */
     saleStatus?: TicketSaleStatus[];
     /**
      * 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_list-ticket-definitions).
+     * @maxLength 20
+     * @maxSize 10
      */
     facet?: string[];
 }
@@ -325,9 +394,15 @@ export interface ResponseMetaData {
     total?: number;
 }
 export interface GetTicketDefinitionRequest {
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     definitionId: string;
-    /** 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[];
 }
 export interface GetTicketDefinitionResponse {
@@ -335,17 +410,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;
@@ -357,7 +441,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;
@@ -379,25 +466,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;
@@ -411,9 +519,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 {
@@ -421,7 +535,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 */
@@ -432,7 +549,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 {
@@ -440,15 +562,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 {
@@ -456,9 +591,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 {
@@ -478,9 +619,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;
@@ -488,26 +635,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 {

package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"events-v1-ticket-definition-ticket-definitions.types.js","sourceRoot":"","sources":["../../../src/events-v1-ticket-definition-ticket-definitions.types.ts"],"names":[],"mappings":";;;AA+EA,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,oDAAoD;IACpD,kCAAuB,CAAA;IACvB,oEAAoE;IACpE,wCAA6B,CAAA;IAC7B,oDAAoD;IACpD,0DAA+C,CAAA;AACjD,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AAWD,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yCAAyC;IACzC,qDAAiC,CAAA;IACjC,+BAA+B;IAC/B,iDAA6B,CAAA;IAC7B,6BAA6B;IAC7B,6CAAyB,CAAA;AAC3B,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAED,IAAY,8BAEX;AAFD,WAAY,8BAA8B;IACxC,2FAAyD,CAAA;AAC3D,CAAC,EAFW,8BAA8B,8CAA9B,8BAA8B,QAEzC;AAwCD,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,6BAAqB,CAAA;IACrB,6BAAqB,CAAA;AACvB,CAAC,EAHW,IAAI,oBAAJ,IAAI,QAGf;AAuBD,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,wCAAwC;IACxC,6CAAiB,CAAA;IACjB,2CAA2C;IAC3C,mDAAuB,CAAA;AACzB,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AA+DD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA2ED,IAAY,KASX;AATD,WAAY,KAAK;IACf,4CAA4C;IAC5C,4BAAmB,CAAA;IACnB,8CAA8C;IAC9C,0BAAiB,CAAA;IACjB,6BAA6B;IAC7B,sBAAa,CAAA;IACb,0CAA0C;IAC1C,sBAAa,CAAA;AACf,CAAC,EATW,KAAK,qBAAL,KAAK,QAShB;AAED,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,mBAAmB;IACnB,wBAAa,CAAA;IACb,4DAA4D;IAC5D,oDAAyC,CAAA;IACzC,2DAA2D;IAC3D,kDAAuC,CAAA;AACzC,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AAqOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"events-v1-ticket-definition-ticket-definitions.types.js","sourceRoot":"","sources":["../../../src/events-v1-ticket-definition-ticket-definitions.types.ts"],"names":[],"mappings":";;;AA6FA,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,oDAAoD;IACpD,kCAAuB,CAAA;IACvB,oEAAoE;IACpE,wCAA6B,CAAA;IAC7B,oDAAoD;IACpD,0DAA+C,CAAA;AACjD,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AAWD,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yCAAyC;IACzC,qDAAiC,CAAA;IACjC,+BAA+B;IAC/B,iDAA6B,CAAA;IAC7B,6BAA6B;IAC7B,6CAAyB,CAAA;AAC3B,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAED,IAAY,8BAEX;AAFD,WAAY,8BAA8B;IACxC,2FAAyD,CAAA;AAC3D,CAAC,EAFW,8BAA8B,8CAA9B,8BAA8B,QAEzC;AA+CD,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,6BAAqB,CAAA;IACrB,6BAAqB,CAAA;AACvB,CAAC,EAHW,IAAI,oBAAJ,IAAI,QAGf;AAgCD,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,wCAAwC;IACxC,6CAAiB,CAAA;IACjB,2CAA2C;IAC3C,mDAAuB,CAAA;AACzB,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAqED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA4GD,IAAY,KASX;AATD,WAAY,KAAK;IACf,4CAA4C;IAC5C,4BAAmB,CAAA;IACnB,8CAA8C;IAC9C,0BAAiB,CAAA;IACjB,6BAA6B;IAC7B,sBAAa,CAAA;IACb,0CAA0C;IAC1C,sBAAa,CAAA;AACf,CAAC,EATW,KAAK,qBAAL,KAAK,QAShB;AAED,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,mBAAmB;IACnB,wBAAa,CAAA;IACb,4DAA4D;IAC5D,oDAAyC,CAAA;IACzC,2DAA2D;IAC3D,kDAAuC,CAAA;AACzC,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AA2UD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}