@wix/auto_sdk_events_tickets 1.0.16 → 1.0.18

package/build/internal/es/{events-v1-ticket-tickets.universal-pbX6XcSr.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface TicketingTicket {
     /** A unique ticket number which is assigned automatically when creating a ticket. */
     ticketNumber?: string;
@@ -19,12 +21,6 @@ interface TicketingTicket {
     free?: boolean;
     /** Ticket and event policies. */
     policy?: string;
-    /**
-     * @internal
-     * @internal
-     * @deprecated
-     */
-    qrCode?: string;
     /** Ticket check-in. */
     checkIn?: CheckIn;
     /**
@@ -40,7 +36,7 @@ interface TicketingTicket {
     orderStatus?: OrderStatusWithLiterals;
     /**
      * Whether the order and ticket are archived.
-     * If set to `true`, they are not visible in the order list.
+     * If set to `true`, they aren't visible in the order list.
      */
     orderArchived?: boolean;
     /** Buyer full name. */
@@ -51,12 +47,6 @@ interface TicketingTicket {
     guestDetails?: GuestDetails;
     /** Whether the ticket is visible in an order. */
     archived?: boolean;
-    /**
-     * @internal
-     * @internal
-     * @deprecated
-     */
-    ticketPdf?: string;
     /**
      * Ticket owner member ID.
      * @format GUID
@@ -115,7 +105,7 @@ interface CheckIn {
     created?: Date | null;
 }
 declare enum OrderStatus {
-    /** Order status is not available for this request fieldset. */
+    /** Order status isn't available for this request fieldset. */
     NA_ORDER_STATUS = "NA_ORDER_STATUS",
     /** Order is confirmed, no payment is required. */
     FREE = "FREE",
@@ -123,9 +113,9 @@ declare enum OrderStatus {
     PENDING = "PENDING",
     /** Order is paid. */
     PAID = "PAID",
-    /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
+    /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
     OFFLINE_PENDING = "OFFLINE_PENDING",
-    /** Order is awaiting for payment at the cashier. */
+    /** Order is waiting for payment at the cashier. */
     INITIATED = "INITIATED",
     /** Order is canceled. */
     CANCELED = "CANCELED",
@@ -192,11 +182,11 @@ interface InputValue {
 }
 interface FormattedAddress {
     /**
-     * One line address representation.
+     * 1-line address representation.
      * @maxLength 200
      */
     formatted?: string;
-    /** Address components (optional). */
+    /** Address components. */
     address?: Address;
 }
 /** Physical address */
@@ -259,6 +249,8 @@ declare enum SubdivisionType {
     /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
     COUNTRY = "COUNTRY"
 }
+/** @enumType */
+type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
 /** Subdivision Concordance values */
 interface StandardDetails {
     /**
@@ -268,7 +260,7 @@ interface StandardDetails {
     iso31662?: string | null;
 }
 declare enum ChannelType {
-    /** Buyer created the order via an online channel, such as a website or a mobile app. */
+    /** Buyer created the order via an online channel, such as a website or mobile app. */
     ONLINE = "ONLINE",
     /** Sales person created the order and collected the money. */
     OFFLINE_POS = "OFFLINE_POS"
@@ -333,14 +325,14 @@ interface TicketDetails {
 }
 interface ListTicketsRequest {
     /**
-     * Event IDs.
+     * Event IDs to which the tickets belong.
      * @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.
      * @max 100
      */
     limit?: number;
@@ -461,9 +453,9 @@ declare enum State {
 /** @enumType */
 type StateWithLiterals = State | 'ORDER_ARCHIVED' | 'ORDER_ACTIVE' | 'TICKET_ARCHIVED' | 'TICKET_ACTIVE' | 'CHECKED_IN' | 'NON_CHECKED_IN' | 'FREE' | 'PAID' | 'MEMBER';
 interface ListTicketsResponse {
-    /** Total tickets matching the given filters. */
+    /** Total tickets matching the specified filters. */
     total?: number;
-    /** Offset. */
+    /** Paging offset. */
     offset?: number;
     /**
      * Limit.
@@ -830,6 +822,41 @@ interface TicketOrderUpdatedEnvelope {
     data: OrderUpdated;
     metadata: BaseEventMetadata;
 }
+/** @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @webhook
+ * @eventType wix.events.ticketing.events.OrderUpdated
+ * @serviceIdentifier wix.events.ticketing.TicketManagement
+ * @slug order_updated
+ */
+declare function onTicketOrderUpdated(handler: (event: TicketOrderUpdatedEnvelope) => void | Promise<void>): void;
+type TicketNonNullablePaths = `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`;
+/**
+ * Retrieves a list of up to 100 tickets.
+ *
+ * <!--
+ * >**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` | {
+    [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+}[TicketNonNullablePaths]>>;
 interface ListTicketsOptions {
     /**
      *
@@ -927,6 +954,20 @@ interface ListTicketsOptions {
      */
     seatId?: string[];
 }
+/**
+ * Retrieves a ticket by the unique ticket number.
+ * @public
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.ticketNumber
+ * @param identifiers - Details for the ticket to retrieve.
+ * @param options - Options for the returned ticket data.
+ * @permissionId WIX_EVENTS.READ_TICKET_DETAILS
+ * @applicableIdentity APP
+ * @returns Ticket.
+ * @fqn wix.events.ticketing.TicketManagement.GetTicket
+ */
+declare function getTicket(identifiers: NonNullablePaths<GetTicketIdentifiers, `eventId` | `ticketNumber`>, options?: GetTicketOptions): Promise<NonNullablePaths<TicketingTicket, TicketNonNullablePaths>>;
 interface GetTicketIdentifiers {
     /**
      * Event ID to which the ticket belongs.
@@ -951,6 +992,19 @@ interface GetTicketOptions {
      */
     fieldset?: TicketFieldsetWithLiterals[];
 }
+/**
+ * Checks in 1 or more tickets.
+ * @public
+ * @requiredField eventId
+ * @param eventId - Event ID to which the ticket belongs.
+ * @param options - Options for tickets to check-in.
+ * @permissionId WIX_EVENTS.CHECK-IN
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketManagement.CheckInTicket
+ */
+declare function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise<NonNullablePaths<CheckInTicketResponse, {
+    [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+}[TicketNonNullablePaths]>>;
 interface CheckInTicketsOptions {
     /**
      * Tickets to check-in.
@@ -961,6 +1015,19 @@ interface CheckInTicketsOptions {
      */
     ticketNumber?: string[];
 }
+/**
+ * Deletes check-ins for 1 or more tickets.
+ * @public
+ * @requiredField eventId
+ * @param eventId - Event ID to which the ticket belongs.
+ * @param options - Options for tickets to delete.
+ * @permissionId WIX_EVENTS.CHECK-IN
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketManagement.DeleteTicketCheckIn
+ */
+declare function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise<NonNullablePaths<DeleteTicketCheckInResponse, {
+    [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+}[TicketNonNullablePaths]>>;
 interface DeleteTicketCheckInsOptions {
     /**
      * Ticket numbers which check-ins to delete.
@@ -971,6 +1038,21 @@ interface DeleteTicketCheckInsOptions {
      */
     ticketNumber?: string[];
 }
+/**
+ * Updates a ticket.
+ * @public
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.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`>, options?: UpdateTicketOptions): Promise<NonNullablePaths<UpdateTicketResponse, {
+    [P in TicketNonNullablePaths]: `ticket.${P}`;
+}[TicketNonNullablePaths]>>;
 interface UpdateTicketIdentifiers {
     /**
      * Event ID to which the ticket belongs.
@@ -996,6 +1078,19 @@ interface UpdateTicketOptions {
     /** Assigned guest details. */
     guestDetails?: GuestDetailsUpdate;
 }
+/**
+ * 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, {
+    [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+}[TicketNonNullablePaths]>>;
 interface BulkUpdateTicketsOptions {
     /**
      * A unique ticket number which is assigned automatically when creating a ticket.
@@ -1009,4 +1104,4 @@ interface BulkUpdateTicketsOptions {
     archived?: boolean;
 }
 
-export { type IdentificationDataIdOneOf as $, type Address as A, type BulkUpdateTicketsOptions as B, type CheckInTicketsOptions as C, type DeleteTicketCheckInsOptions as D, type GetTicketResponse as E, type FormResponse as F, type GetTicketIdentifiers as G, type CheckInTicketRequest as H, type InputValue as I, type OrderUpdated as J, type Ticket as K, type ListTicketsOptions as L, type Money as M, type OnlineConferencingLogin as N, OrderStatus as O, type DeleteTicketCheckInRequest as P, type UpdateTicketRequest as Q, type GuestDetailsUpdate as R, SubdivisionType as S, type TicketingTicket as T, type UpdateTicketIdentifiers as U, type BulkUpdateTicketsRequest as V, WebhookIdentityType as W, type GetDemoTicketRequest as X, type GetDemoTicketResponse as Y, type MessageEnvelope as Z, type IdentificationData as _, type ListTicketsResponse as a, type BaseEventMetadata as a0, type GetTicketOptions as b, type CheckInTicketResponse as c, type DeleteTicketCheckInResponse as d, type UpdateTicketOptions as e, type UpdateTicketResponse as f, type BulkUpdateTicketsResponse as g, type TicketOrderUpdatedEnvelope as h, ChannelType as i, TicketFieldset as j, State as k, type CheckIn as l, type GuestDetails as m, type FormattedAddress as n, type AddressStreetOneOf as o, type StreetAddress as p, type AddressLocation as q, type Subdivision as r, type StandardDetails as s, type TicketDetails as t, type ListTicketsRequest as u, type FacetCounts as v, type TicketFacets as w, type TicketFacetCounts as x, type Counts as y, type GetTicketRequest as z };
+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 };