@wix/auto_sdk_events_tickets 1.0.31 → 1.0.33

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

@@ -334,7 +334,7 @@ interface ListTicketsRequest {
      * Event IDs to which the tickets belong.
      * @format GUID
      */
-    eventId: string[];
+    eventId?: string[];
     /** Offset. See [Pagination](/wix-events-v2/pagination). */
     offset?: number;
     /**
@@ -496,7 +496,7 @@ interface GetTicketRequest {
      * Event ID to which the ticket belongs.
      * @format GUID
      */
-    eventId: string;
+    eventId?: string;
     /**
      * A unique ticket number which is assigned automatically when creating a ticket.
      * @maxLength 36
@@ -680,7 +680,7 @@ interface UpdateTicketRequest {
      * Event ID to which the ticket belongs.
      * @format GUID
      */
-    eventId: string;
+    eventId?: string;
     /**
      * A unique ticket number which is assigned automatically when creating a ticket.
      * @minLength 1
@@ -711,7 +711,7 @@ interface BulkUpdateTicketsRequest {
      * Event ID to which the ticket belongs.
      * @format GUID
      */
-    eventId: string;
+    eventId?: string;
     /**
      * A unique ticket number which is assigned automatically when creating a ticket.
      * @minLength 1
@@ -851,16 +851,19 @@ declare function onTicketOrderUpdated(handler: (event: TicketOrderUpdatedEnvelop
  * <!--
  * >**Note:** This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
  * -->
- * @param eventId - Event IDs to which the tickets belong.
  * @public
- * @requiredField eventId
  * @param options - Options for defining the returned list of tickets.
  * @permissionId WIX_EVENTS.READ_TICKETS
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.TicketManagement.ListTickets
  */
-declare function listTickets(eventId: string[], options?: ListTicketsOptions): Promise<NonNullablePaths<ListTicketsResponse, `total` | `offset` | `limit` | `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl`, 5>>;
+declare function listTickets(options?: ListTicketsOptions): Promise<NonNullablePaths<ListTicketsResponse, `total` | `offset` | `limit` | `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl`, 5>>;
 interface ListTicketsOptions {
+    /**
+     * Event IDs to which the tickets belong.
+     * @format GUID
+     */
+    eventId?: string[];
     /**
      *
      * Offset. See [Pagination](/wix-events-v2/pagination).
@@ -959,10 +962,9 @@ interface ListTicketsOptions {
 }
 /**
  * Retrieves a ticket by the unique ticket number.
+ * @param ticketNumber - A unique ticket number which is assigned automatically when creating a ticket.
  * @public
- * @requiredField identifiers
- * @requiredField identifiers.eventId
- * @requiredField identifiers.ticketNumber
+ * @requiredField ticketNumber
  * @param identifiers - Details for the ticket to retrieve.
  * @param options - Options for the returned ticket data.
  * @permissionId WIX_EVENTS.READ_TICKET_DETAILS
@@ -970,20 +972,13 @@ interface ListTicketsOptions {
  * @returns Ticket.
  * @fqn wix.events.ticketing.TicketManagement.GetTicket
  */
-declare function getTicket(identifiers: NonNullablePaths<GetTicketIdentifiers, `eventId` | `ticketNumber`, 2>, options?: GetTicketOptions): Promise<NonNullablePaths<TicketingTicket, `ticketNumber` | `orderNumber` | `ticketDefinitionId` | `name` | `price.amount` | `price.currency` | `free` | `policy` | `orderStatus` | `orderArchived` | `orderFullName` | `guestDetails.guestAssigned` | `guestDetails.form.inputValues` | `guestDetails.form.inputValues.${number}.inputName` | `guestDetails.form.inputValues.${number}.value` | `archived` | `anonymized` | `checkInUrl` | `ticketPdfUrl` | `channel` | `walletPassUrl`, 6>>;
-interface GetTicketIdentifiers {
+declare function getTicket(ticketNumber: string, options?: GetTicketOptions): Promise<NonNullablePaths<TicketingTicket, `ticketNumber` | `orderNumber` | `ticketDefinitionId` | `name` | `price.amount` | `price.currency` | `free` | `policy` | `orderStatus` | `orderArchived` | `orderFullName` | `guestDetails.guestAssigned` | `guestDetails.form.inputValues` | `guestDetails.form.inputValues.${number}.inputName` | `guestDetails.form.inputValues.${number}.value` | `archived` | `anonymized` | `checkInUrl` | `ticketPdfUrl` | `channel` | `walletPassUrl`, 6>>;
+interface GetTicketOptions {
     /**
      * Event ID to which the ticket belongs.
      * @format GUID
      */
-    eventId: string;
-    /**
-     * A unique ticket number which is assigned automatically when creating a ticket.
-     * @maxLength 36
-     */
-    ticketNumber: string;
-}
-interface GetTicketOptions {
+    eventId?: string;
     /**
      * Predefined sets of fields to return.
      * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
@@ -1039,31 +1034,22 @@ interface DeleteTicketCheckInsOptions {
 }
 /**
  * Updates a ticket.
+ * @param ticketNumber - A unique ticket number which is assigned automatically when creating a ticket.
  * @public
- * @requiredField identifiers
- * @requiredField identifiers.eventId
- * @requiredField identifiers.ticketNumber
+ * @requiredField ticketNumber
  * @param identifiers - Details for the ticket to update.
  * @param options - Ticket details to update.
  * @permissionId WIX_EVENTS.MANAGE_TICKETS
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.TicketManagement.UpdateTicket
  */
-declare function updateTicket(identifiers: NonNullablePaths<UpdateTicketIdentifiers, `eventId` | `ticketNumber`, 2>, options?: UpdateTicketOptions): Promise<NonNullablePaths<UpdateTicketResponse, `ticket.ticketNumber` | `ticket.orderNumber` | `ticket.ticketDefinitionId` | `ticket.name` | `ticket.price.amount` | `ticket.price.currency` | `ticket.free` | `ticket.policy` | `ticket.orderStatus` | `ticket.orderArchived` | `ticket.orderFullName` | `ticket.guestDetails.guestAssigned` | `ticket.guestDetails.form.inputValues` | `ticket.guestDetails.form.inputValues.${number}.inputName` | `ticket.guestDetails.form.inputValues.${number}.value` | `ticket.archived` | `ticket.anonymized` | `ticket.checkInUrl` | `ticket.ticketPdfUrl` | `ticket.channel` | `ticket.walletPassUrl`, 7>>;
-interface UpdateTicketIdentifiers {
+declare function updateTicket(ticketNumber: string, options?: UpdateTicketOptions): Promise<NonNullablePaths<UpdateTicketResponse, `ticket.ticketNumber` | `ticket.orderNumber` | `ticket.ticketDefinitionId` | `ticket.name` | `ticket.price.amount` | `ticket.price.currency` | `ticket.free` | `ticket.policy` | `ticket.orderStatus` | `ticket.orderArchived` | `ticket.orderFullName` | `ticket.guestDetails.guestAssigned` | `ticket.guestDetails.form.inputValues` | `ticket.guestDetails.form.inputValues.${number}.inputName` | `ticket.guestDetails.form.inputValues.${number}.value` | `ticket.archived` | `ticket.anonymized` | `ticket.checkInUrl` | `ticket.ticketPdfUrl` | `ticket.channel` | `ticket.walletPassUrl`, 7>>;
+interface UpdateTicketOptions {
     /**
      * Event ID to which the ticket belongs.
      * @format GUID
      */
-    eventId: string;
-    /**
-     * A unique ticket number which is assigned automatically when creating a ticket.
-     * @minLength 1
-     * @maxLength 36
-     */
-    ticketNumber: string;
-}
-interface UpdateTicketOptions {
+    eventId?: string;
     /**
      * Set of field paths, specifying which parts of this resource to update.
      * When `fields` is empty, the request is interpreted as a full update.
@@ -1078,15 +1064,19 @@ interface UpdateTicketOptions {
 /**
  * Archives multiple tickets.
  * @public
- * @requiredField eventId
  * @param options - Options for updating the tickets.
  * @param eventId - Event ID to which the ticket belongs.
  * @permissionId WIX_EVENTS.MANAGE_TICKETS
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.TicketManagement.BulkUpdateTickets
  */
-declare function bulkUpdateTickets(eventId: string, options?: BulkUpdateTicketsOptions): Promise<NonNullablePaths<BulkUpdateTicketsResponse, `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl`, 5>>;
+declare function bulkUpdateTickets(options?: BulkUpdateTicketsOptions): Promise<NonNullablePaths<BulkUpdateTicketsResponse, `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl`, 5>>;
 interface BulkUpdateTicketsOptions {
+    /**
+     * Event ID to which the ticket belongs.
+     * @format GUID
+     */
+    eventId?: string;
     /**
      * A unique ticket number which is assigned automatically when creating a ticket.
      * @minLength 1
@@ -1099,4 +1089,4 @@ interface BulkUpdateTicketsOptions {
     archived?: boolean;
 }
 
-export { type Address, type AddressLocation, type AddressStreetOneOf, type BaseEventMetadata, type BulkUpdateTicketsOptions, type BulkUpdateTicketsRequest, type BulkUpdateTicketsResponse, ChannelType, type ChannelTypeWithLiterals, type CheckIn, type CheckInTicketRequest, type CheckInTicketResponse, type CheckInTicketsOptions, type Counts, type DeleteTicketCheckInRequest, type DeleteTicketCheckInResponse, type DeleteTicketCheckInsOptions, type FacetCounts, type FormResponse, type FormattedAddress, type GetDemoTicketRequest, type GetDemoTicketResponse, type GetTicketIdentifiers, type GetTicketOptions, type GetTicketRequest, type GetTicketResponse, type GuestDetails, type GuestDetailsUpdate, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type ListTicketsOptions, type ListTicketsRequest, type ListTicketsResponse, type MessageEnvelope, type Money, type OnlineConferencingLogin, OrderStatus, type OrderStatusWithLiterals, type OrderUpdated, type StandardDetails, State, type StateWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Ticket, type TicketDetails, type TicketFacetCounts, type TicketFacets, TicketFieldset, type TicketFieldsetWithLiterals, type TicketOrderUpdatedEnvelope, type TicketingTicket, type UpdateTicketIdentifiers, type UpdateTicketOptions, type UpdateTicketRequest, type UpdateTicketResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateTickets, checkInTickets, deleteTicketCheckIns, getTicket, listTickets, onTicketOrderUpdated, updateTicket };
+export { type Address, type AddressLocation, type AddressStreetOneOf, type BaseEventMetadata, type BulkUpdateTicketsOptions, type BulkUpdateTicketsRequest, type BulkUpdateTicketsResponse, ChannelType, type ChannelTypeWithLiterals, type CheckIn, type CheckInTicketRequest, type CheckInTicketResponse, type CheckInTicketsOptions, type Counts, type DeleteTicketCheckInRequest, type DeleteTicketCheckInResponse, type DeleteTicketCheckInsOptions, type FacetCounts, type FormResponse, type FormattedAddress, type GetDemoTicketRequest, type GetDemoTicketResponse, type GetTicketOptions, type GetTicketRequest, type GetTicketResponse, type GuestDetails, type GuestDetailsUpdate, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type ListTicketsOptions, type ListTicketsRequest, type ListTicketsResponse, type MessageEnvelope, type Money, type OnlineConferencingLogin, OrderStatus, type OrderStatusWithLiterals, type OrderUpdated, type StandardDetails, State, type StateWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Ticket, type TicketDetails, type TicketFacetCounts, type TicketFacets, TicketFieldset, type TicketFieldsetWithLiterals, type TicketOrderUpdatedEnvelope, type TicketingTicket, type UpdateTicketOptions, type UpdateTicketRequest, type UpdateTicketResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateTickets, checkInTickets, deleteTicketCheckIns, getTicket, listTickets, onTicketOrderUpdated, updateTicket };