@wix/auto_sdk_events_tickets 1.0.2 → 1.0.3

package/build/cjs/src/events-v1-ticket-tickets.universal.d.ts

@@ -3,7 +3,10 @@ export interface TicketingTicket {
     ticketNumber?: string;
     /** Associated order number. */
     orderNumber?: string;
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     ticketDefinitionId?: string;
     /** Ticket name. */
     name?: string;
@@ -39,7 +42,10 @@ export interface TicketingTicket {
     guestDetails?: GuestDetails;
     /** Whether the ticket is visible in an order. */
     archived?: boolean;
-    /** Ticket owner member ID. */
+    /**
+     * Ticket owner member ID.
+     * @format GUID
+     */
     memberId?: string | null;
     /**
      * Whether ticket was anonymized by GDPR delete.
@@ -61,6 +67,7 @@ export interface TicketingTicket {
     channel?: ChannelType;
     /**
      * An URL to download a ticket in the `.pkpass` format for Apple Wallet.
+     * @format WEB_URL
      * @readonly
      */
     walletPassUrl?: string;
@@ -73,12 +80,19 @@ export interface TicketingTicket {
 export interface Money {
     /**
      * *Deprecated:** Use `value` instead.
+     * @format DECIMAL_VALUE
      * @deprecated
      */
     amount?: string;
-    /** Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`. */
+    /**
+     * Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `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 CheckIn {
@@ -116,29 +130,54 @@ export interface GuestDetails {
     firstName?: string | null;
     /** Guest last name. */
     lastName?: string | null;
-    /** Guest email. */
+    /**
+     * Guest email.
+     * @format EMAIL
+     */
     email?: string | null;
     /** Full form response. */
     form?: FormResponse;
-    /** Contact ID associated with this guest. */
+    /**
+     * Contact ID associated with this guest.
+     * @format GUID
+     */
     contactId?: string | null;
-    /** Guest phone number. */
+    /**
+     * Guest phone number.
+     * @format PHONE
+     */
     phone?: string | null;
 }
 export interface FormResponse {
-    /** Form field inputs. */
+    /**
+     * Form field inputs.
+     * @maxSize 200
+     */
     inputValues?: InputValue[];
 }
 export interface InputValue {
-    /** Form field input name. */
+    /**
+     * Form field input name.
+     * @maxLength 100
+     */
     inputName?: string;
-    /** Form field value. */
+    /**
+     * Form field value.
+     * @maxLength 5000
+     */
     value?: string;
-    /** Form field values. */
+    /**
+     * Form field values.
+     * @maxSize 100
+     * @maxLength 5000
+     */
     values?: string[];
 }
 export interface FormattedAddress {
-    /** One line address representation. */
+    /**
+     * One line address representation.
+     * @maxLength 200
+     */
     formatted?: string;
     /** Address components (optional). */
     address?: Address;
@@ -149,7 +188,10 @@ export interface Address extends AddressStreetOneOf {
     streetAddress?: StreetAddress;
     /** Main address line, usually street and number as free text. */
     addressLine1?: string | null;
-    /** Country code. */
+    /**
+     * Country code.
+     * @format COUNTRY
+     */
     country?: string | null;
     /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
     subdivision?: string | null;
@@ -202,7 +244,10 @@ export declare enum SubdivisionType {
 }
 /** Subdivision Concordance values */
 export interface StandardDetails {
-    /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */
+    /**
+     * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
+     * @maxLength 20
+     */
     iso31662?: string | null;
 }
 export declare enum ChannelType {
@@ -212,7 +257,11 @@ export declare enum ChannelType {
     OFFLINE_POS = "OFFLINE_POS"
 }
 export interface TicketDetails {
-    /** Unique seat id in the event venue. */
+    /**
+     * Unique seat id in the event venue.
+     * @minLength 1
+     * @maxLength 36
+     */
     seatId?: string | null;
     /**
      * Optional sector label.
@@ -239,11 +288,21 @@ export interface TicketDetails {
      * @readonly
      */
     seatLabel?: string | null;
-    /** Number of places in the spot. If not provided - defaults to 1. */
+    /**
+     * Number of places in the spot. If not provided - defaults to 1.
+     * @min 1
+     * @max 50
+     */
     capacity?: number | null;
-    /** Custom pricing of ticket. */
+    /**
+     * Custom pricing of ticket.
+     * @format DECIMAL_VALUE
+     */
     priceOverride?: string | null;
-    /** Pricing option id. */
+    /**
+     * Pricing option id.
+     * @format GUID
+     */
     pricingOptionId?: string | null;
     /**
      * Pricing option name.
@@ -252,19 +311,41 @@ export interface TicketDetails {
     pricingOptionName?: string | null;
 }
 export interface ListTicketsRequest {
-    /** Event IDs. */
+    /**
+     * Event IDs.
+     * @format GUID
+     */
     eventId: string[];
     /** Offset. See [Pagination](/wix-events-v2/pagination). */
     offset?: number;
-    /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     * @max 100
+     */
     limit?: number;
-    /** Order numbers. */
+    /**
+     * Order numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 20
+     */
     orderNumber?: string[];
-    /** Ticket numbers. */
+    /**
+     * Ticket numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 50
+     */
     ticketNumber?: string[];
-    /** Searches in the `orderFullName`, `guestFullName`, and `ticketNumber` fields. */
+    /**
+     * Searches in the `orderFullName`, `guestFullName`, and `ticketNumber` fields.
+     * @maxLength 200
+     */
     searchPhrase?: string;
-    /** Order statuses. */
+    /**
+     * Order statuses.
+     * @maxSize 20
+     */
     orderStatus?: OrderStatus[];
     /**
      * Predefined sets of fields to return.
@@ -273,6 +354,7 @@ export interface ListTicketsRequest {
      * - `GUEST_FORM`: Returns `guestDetails.form`.
      *
      * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
+     * @maxSize 20
      */
     fieldset?: TicketFieldset[];
     /**
@@ -286,19 +368,43 @@ export interface ListTicketsRequest {
      * - `FREE`: Returns free tickets.
      * - `PAID`: Return paid tickets.
      * - `MEMBER`: Return members' tickets.
+     * @maxSize 20
      */
     state?: State[];
-    /** Site member IDs. */
+    /**
+     * Site member IDs.
+     * @format GUID
+     * @maxSize 500
+     */
     memberId?: string[];
-    /** Filter facets. */
+    /**
+     * Filter facets.
+     * @maxLength 100
+     * @maxSize 20
+     */
     facet?: string[];
-    /** Sort order. Defaults to "ticket_number:asc". */
+    /**
+     * Sort order. Defaults to "ticket_number:asc".
+     * @maxLength 100
+     */
     sort?: string;
-    /** Guest contact IDs. */
+    /**
+     * Guest contact IDs.
+     * @format GUID
+     * @maxSize 100
+     */
     contactId?: string[];
-    /** Ticket definition IDs. */
+    /**
+     * Ticket definition IDs.
+     * @format GUID
+     * @maxSize 10
+     */
     ticketDefinitionId?: string[];
-    /** Seat IDs. */
+    /**
+     * Seat IDs.
+     * @maxLength 36
+     * @maxSize 50
+     */
     seatId?: string[];
 }
 export declare enum TicketFieldset {
@@ -334,7 +440,10 @@ export interface ListTicketsResponse {
     total?: number;
     /** Offset. */
     offset?: number;
-    /** Limit. */
+    /**
+     * Limit.
+     * @max 100
+     */
     limit?: number;
     /** Tickets. */
     tickets?: TicketingTicket[];
@@ -360,9 +469,15 @@ export interface Counts {
     checkedIn?: number;
 }
 export interface GetTicketRequest {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** A unique ticket number which is assigned automatically when creating a ticket. */
+    /**
+     * A unique ticket number which is assigned automatically when creating a ticket.
+     * @maxLength 36
+     */
     ticketNumber: string;
     /**
      * Predefined sets of fields to return.
@@ -371,6 +486,7 @@ export interface GetTicketRequest {
      * - `GUEST_FORM`: Returns `guestDetails.form`.
      *
      * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
+     * @maxSize 20
      */
     fieldset?: TicketFieldset[];
 }
@@ -379,9 +495,18 @@ export interface GetTicketResponse {
     ticket?: TicketingTicket;
 }
 export interface CheckInTicketRequest {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** Tickets to check-in. */
+    /**
+     * Tickets to check-in.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
     ticketNumber?: string[];
 }
 export interface CheckInTicketResponse {
@@ -391,17 +516,29 @@ export interface CheckInTicketResponse {
 export interface OrderUpdated {
     /** Order updated timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Site language when Order initiated */
+    /**
+     * Site language when Order initiated
+     * @format LANGUAGE
+     */
     language?: string | null;
-    /** Locale in which Order was created. */
+    /**
+     * Locale in which Order was created.
+     * @format LANGUAGE_TAG
+     */
     locale?: string | null;
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
     /** Contact ID associated with this order. */
     contactId?: string;
-    /** Member ID associated with this order. */
+    /**
+     * Member ID associated with this order.
+     * @format GUID
+     */
     memberId?: string | null;
     /**
      * Order created timestamp.
@@ -437,7 +574,10 @@ export interface OrderUpdated {
 export interface Ticket {
     /** Unique issued ticket number. */
     ticketNumber?: string;
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     ticketDefinitionId?: string;
     /** Ticket check-in. */
     checkIn?: CheckIn;
@@ -451,11 +591,17 @@ export interface Ticket {
     lastName?: string | null;
     /** Guest email. */
     email?: string | null;
-    /** Contact ID associated with this ticket. */
+    /**
+     * Contact ID associated with this ticket.
+     * @format GUID
+     */
     contactId?: string | null;
     /** Whether ticket is confirmed */
     confirmed?: boolean;
-    /** Member ID associated with this ticket. */
+    /**
+     * Member ID associated with this ticket.
+     * @format GUID
+     */
     memberId?: string | null;
     /** Ticket form response (only assigned tickets contain separate forms). */
     form?: FormResponse;
@@ -465,7 +611,10 @@ export interface Ticket {
     anonymized?: boolean;
     /** URL and password to online conference */
     onlineConferencingLogin?: OnlineConferencingLogin;
-    /** Seat ID associated with this ticket. */
+    /**
+     * Seat ID associated with this ticket.
+     * @maxLength 36
+     */
     seatId?: string | null;
     /** Whether ticket is canceled. */
     canceled?: boolean | null;
@@ -473,6 +622,7 @@ export interface Ticket {
 export interface OnlineConferencingLogin {
     /**
      * Link URL to the online conference.
+     * @format WEB_URL
      * @readonly
      */
     link?: string;
@@ -483,9 +633,18 @@ export interface OnlineConferencingLogin {
     password?: string | null;
 }
 export interface DeleteTicketCheckInRequest {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** Ticket numbers which check-ins to delete. */
+    /**
+     * Ticket numbers which check-ins to delete.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
     ticketNumber?: string[];
 }
 export interface DeleteTicketCheckInResponse {
@@ -493,9 +652,16 @@ export interface DeleteTicketCheckInResponse {
     tickets?: TicketingTicket[];
 }
 export interface UpdateTicketRequest {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** A unique ticket number which is assigned automatically when creating a ticket. */
+    /**
+     * A unique ticket number which is assigned automatically when creating a ticket.
+     * @minLength 1
+     * @maxLength 36
+     */
     ticketNumber: string;
     /**
      * Set of field paths, specifying which parts of this resource to update.
@@ -517,9 +683,18 @@ export interface UpdateTicketResponse {
     ticket?: TicketingTicket;
 }
 export interface BulkUpdateTicketsRequest {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** A unique ticket number which is assigned automatically when creating a ticket. */
+    /**
+     * A unique ticket number which is assigned automatically when creating a ticket.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
     ticketNumber?: string[];
     /** Whether tickets are archived. */
     archived?: boolean;
@@ -529,7 +704,10 @@ export interface BulkUpdateTicketsResponse {
     tickets?: TicketingTicket[];
 }
 export interface GetDemoTicketRequest {
-    /** Ticket definition ID. */
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
     definitionId?: string;
 }
 export interface GetDemoTicketResponse {
@@ -537,9 +715,15 @@ export interface GetDemoTicketResponse {
     ticket?: TicketingTicket;
 }
 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;
@@ -547,26 +731,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 {
@@ -652,9 +860,15 @@ export interface BulkUpdateTicketsResponseNonNullableFields {
     tickets: TicketingTicketNonNullableFields[];
 }
 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;
@@ -711,15 +925,34 @@ export interface ListTicketsOptions {
      * Offset. See [Pagination](/wix-events-v2/pagination).
      */
     offset?: number;
-    /** Number of items to load per page. See [Pagination](/wix-events-v2/pagination).   */
+    /**
+     * Number of items to load per page. See [Pagination](/wix-events-v2/pagination).
+     * @max 100
+     */
     limit?: number;
-    /** Order numbers. */
+    /**
+     * Order numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 20
+     */
     orderNumber?: string[];
-    /** Ticket numbers. */
+    /**
+     * Ticket numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 50
+     */
     ticketNumber?: string[];
-    /** Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`. */
+    /**
+     * Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`.
+     * @maxLength 200
+     */
     searchPhrase?: string;
-    /** Order statuses. */
+    /**
+     * Order statuses.
+     * @maxSize 20
+     */
     orderStatus?: OrderStatus[];
     /**
      * Predefined sets of fields to return.
@@ -728,6 +961,7 @@ export interface ListTicketsOptions {
      * - `GUEST_FORM`: Returns `guestDetails.form`.
      *
      * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
+     * @maxSize 20
      */
     fieldset?: TicketFieldset[];
     /**
@@ -741,23 +975,45 @@ export interface ListTicketsOptions {
      * - `FREE`: Returns free tickets.
      * - `PAID`: Return paid tickets.
      * - `MEMBER`: Return members' tickets.
+     * @maxSize 20
      */
     state?: State[];
-    /** Site member IDs. */
+    /**
+     * Site member IDs.
+     * @format GUID
+     * @maxSize 500
+     */
     memberId?: string[];
-    /** Filter facets. */
+    /**
+     * Filter facets.
+     * @maxLength 100
+     * @maxSize 20
+     */
     facet?: string[];
     /**
      * Sort order.
      *
      * Default: `"ticketNumber"`:`"asc"`.
+     * @maxLength 100
      */
     sort?: string;
-    /** Guest contact IDs. */
+    /**
+     * Guest contact IDs.
+     * @format GUID
+     * @maxSize 100
+     */
     contactId?: string[];
-    /** Ticket definition IDs. */
+    /**
+     * Ticket definition IDs.
+     * @format GUID
+     * @maxSize 10
+     */
     ticketDefinitionId?: string[];
-    /** Seat IDs. */
+    /**
+     * Seat IDs.
+     * @maxLength 36
+     * @maxSize 50
+     */
     seatId?: string[];
 }
 /**
@@ -785,9 +1041,15 @@ export interface ListTicketsOptions {
  */
 export declare function getTicket(identifiers: GetTicketIdentifiers, options?: GetTicketOptions): Promise<TicketingTicket & TicketingTicketNonNullableFields>;
 export interface GetTicketIdentifiers {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** A unique ticket number which is assigned automatically when creating a ticket. */
+    /**
+     * A unique ticket number which is assigned automatically when creating a ticket.
+     * @maxLength 36
+     */
     ticketNumber: string;
 }
 export interface GetTicketOptions {
@@ -798,6 +1060,7 @@ export interface GetTicketOptions {
      * - `GUEST_FORM`: Returns `guestDetails.form`.
      *
      * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
+     * @maxSize 20
      */
     fieldset?: TicketFieldset[];
 }
@@ -812,7 +1075,13 @@ export interface GetTicketOptions {
  */
 export declare function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise<CheckInTicketResponse & CheckInTicketResponseNonNullableFields>;
 export interface CheckInTicketsOptions {
-    /** Tickets to check-in. */
+    /**
+     * Tickets to check-in.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
     ticketNumber?: string[];
 }
 /**
@@ -826,7 +1095,13 @@ export interface CheckInTicketsOptions {
  */
 export declare function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise<DeleteTicketCheckInResponse & DeleteTicketCheckInResponseNonNullableFields>;
 export interface DeleteTicketCheckInsOptions {
-    /** Ticket numbers which check-ins to delete. */
+    /**
+     * Ticket numbers which check-ins to delete.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
     ticketNumber?: string[];
 }
 /**
@@ -849,9 +1124,16 @@ export interface DeleteTicketCheckInsOptions {
  */
 export declare function updateTicket(identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions): Promise<UpdateTicketResponse & UpdateTicketResponseNonNullableFields>;
 export interface UpdateTicketIdentifiers {
-    /** Event ID to which the ticket belongs. */
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
     eventId: string;
-    /** A unique ticket number which is assigned automatically when creating a ticket. */
+    /**
+     * A unique ticket number which is assigned automatically when creating a ticket.
+     * @minLength 1
+     * @maxLength 36
+     */
     ticketNumber: string;
 }
 export interface UpdateTicketOptions {
@@ -884,7 +1166,13 @@ export interface UpdateTicketOptions {
  */
 export declare function bulkUpdateTickets(eventId: string, options?: BulkUpdateTicketsOptions): Promise<BulkUpdateTicketsResponse & BulkUpdateTicketsResponseNonNullableFields>;
 export interface BulkUpdateTicketsOptions {
-    /** A unique ticket number which is assigned automatically when creating a ticket. */
+    /**
+     * A unique ticket number which is assigned automatically when creating a ticket.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
     ticketNumber?: string[];
     /** Whether tickets are archived. */
     archived?: boolean;