@wix/auto_sdk_events_tickets 1.0.17 → 1.0.18

package/build/internal/cjs/meta.d.ts

@@ -2,7 +2,7 @@ import { ListTicketsRequest as ListTicketsRequest$1, ListTicketsResponse as List
 import '@wix/sdk-types';
 
 interface TicketingTicket {
-    /** Unique ticket number (issued automatically). */
+    /** Unique ticket number which is assigned automatically when creating a ticket. */
     ticketNumber?: string;
     /** Associated order number. */
     orderNumber?: string;
@@ -20,20 +20,15 @@ interface TicketingTicket {
      * @readonly
      */
     free?: boolean;
-    /** Event and ticket policies. */
+    /** Ticket and event policies. */
     policy?: string;
-    /**
-     * *Deprecated:** Use `tickets.checkInUrl` instead.
-     * @deprecated
-     */
-    qrCode?: string;
     /** Ticket check-in. */
     checkIn?: CheckIn;
     /** Associated order status. */
     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. */
@@ -42,13 +37,8 @@ interface TicketingTicket {
     guestFullName?: string | null;
     /** Guest personal details. */
     guestDetails?: GuestDetails;
-    /** Whether ticket is visible in guest list. */
+    /** Whether the ticket is visible in an order. */
     archived?: boolean;
-    /**
-     * *Deprecated:** Use `tickets.ticketPdfUrl` instead.
-     * @deprecated
-     */
-    ticketPdf?: string;
     /**
      * Ticket owner member ID.
      * @format GUID
@@ -72,7 +62,7 @@ interface TicketingTicket {
     /** Associated order checkout channel type. */
     channel?: ChannelTypeWithLiterals;
     /**
-     * URL to download ticket in `.pkpass` format for Apple Wallet.
+     * URL to download a ticket in `.pkpass` format for Apple Wallet.
      * @format WEB_URL
      * @readonly
      */
@@ -91,7 +81,7 @@ interface Money {
      */
     amount?: string;
     /**
-     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
      * @format CURRENCY
      */
     currency?: string;
@@ -102,11 +92,11 @@ interface Money {
     value?: string | null;
 }
 interface CheckIn {
-    /** Time of check-in. */
+    /** Time of a ticket's check-in. */
     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",
@@ -114,9 +104,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",
@@ -158,31 +148,31 @@ interface GuestDetails {
 }
 interface FormResponse {
     /**
-     * Input values entered when filling the form.
+     * Form field inputs.
      * @maxSize 200
      */
     inputValues?: InputValue[];
 }
 interface InputValue {
     /**
-     * Input field name.
+     * Form field input name.
      * @maxLength 100
      */
     inputName?: string;
     /**
-     * Text entered into the input field.
+     * Form field value.
      * @maxLength 5000
      */
     value?: string;
     /**
-     * Multiple input values. For example, the array is filled if several checkboxes are ticked.
+     * Form field values.
      * @maxSize 100
      * @maxLength 5000
      */
     values?: string[];
 }
 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"
@@ -191,14 +181,14 @@ declare enum ChannelType {
 type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
 interface ListTicketsRequest {
     /**
-     * Event IDs.
+     * Event IDs to which the tickets belong.
      * @format GUID
      */
     eventId: string[];
-    /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /** Paging offset. */
     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;
@@ -217,7 +207,7 @@ interface ListTicketsRequest {
      */
     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;
@@ -243,15 +233,13 @@ interface ListTicketsRequest {
      */
     memberId?: string[];
     /**
-     * Filter facets.
-     * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-tickets).
+     * Filter facets. For supported facets, see Events Schema for Wix Search ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/events-schema-for-wix-search) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/tickets/list-tickets))
      * @maxLength 100
      * @maxSize 20
      */
     facet?: string[];
     /**
-     * Sort order. Defaults to "ticket_number: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-tickets).
+     * Sort order. Defaults to `ticketNumber` in ascending order.
      * @maxLength 100
      */
     sort?: string;
@@ -307,9 +295,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.
@@ -327,7 +315,7 @@ interface FacetCounts {
 }
 interface GetTicketRequest {
     /**
-     * Event ID.
+     * Event ID to which the ticket belongs.
      * @format GUID
      */
     eventId: string;
@@ -348,7 +336,7 @@ interface GetTicketResponse {
 }
 interface CheckInTicketRequest {
     /**
-     * Event ID.
+     * Event ID to which the ticket belongs.
      * @format GUID
      */
     eventId: string;
@@ -367,12 +355,12 @@ interface CheckInTicketResponse {
 }
 interface DeleteTicketCheckInRequest {
     /**
-     * Event ID.
+     * Event ID to which the ticket belongs.
      * @format GUID
      */
     eventId: string;
     /**
-     * Tickets to delete check-ins for.
+     * Ticket numbers to delete check-ins for.
      * @minLength 1
      * @maxLength 36
      * @minSize 1
@@ -386,7 +374,7 @@ interface DeleteTicketCheckInResponse {
 }
 interface UpdateTicketRequest {
     /**
-     * Event ID.
+     * Event ID to which the ticket belongs.
      * @format GUID
      */
     eventId: string;
@@ -402,17 +390,18 @@ interface UpdateTicketRequest {
      * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
      */
     fields?: string[];
-    /** Whether ticket is archived. */
+    /** Whether to archive the ticket. */
     archived?: boolean;
     /** Assigned guest details. */
     guestDetails?: GuestDetailsUpdate;
 }
 interface GuestDetailsUpdate {
     /**
-     * Assigned guest form.
-     * To update non-assigned guest form, use [Update Order](https://dev.wix.com/api/rest/wix-events/wix-events/order/update-order).
+     * Form of a guest assigned to a ticket.
+     *
+     * To update the form of a guest not assigned to a ticket, call Update Order.
      *
-     * Does not support partial updates - entire form object will be replaced when `guestDetails.form` is masked.
+     * Doesn't support partial updates, the entire form object will be replaced when `guestDetails.form` is masked.
      */
     form?: FormResponse;
 }
@@ -422,7 +411,7 @@ interface UpdateTicketResponse {
 }
 interface BulkUpdateTicketsRequest {
     /**
-     * Event ID.
+     * Event ID to which the tickets belong.
      * @format GUID
      */
     eventId: string;

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

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { ListTicketsOptions, ListTicketsResponse, GetTicketIdentifiers, GetTicketOptions, TicketingTicket, CheckInTicketsOptions, CheckInTicketResponse, DeleteTicketCheckInsOptions, DeleteTicketCheckInResponse, UpdateTicketIdentifiers, UpdateTicketOptions, UpdateTicketResponse, BulkUpdateTicketsOptions, BulkUpdateTicketsResponse, TicketOrderUpdatedEnvelope } from './index.typings.mjs';
 export { Address, AddressLocation, AddressStreetOneOf, BaseEventMetadata, BulkUpdateTicketsRequest, ChannelType, CheckIn, CheckInTicketRequest, Counts, DeleteTicketCheckInRequest, FacetCounts, FormResponse, FormattedAddress, GetDemoTicketRequest, GetDemoTicketResponse, GetTicketRequest, GetTicketResponse, GuestDetails, GuestDetailsUpdate, IdentificationData, IdentificationDataIdOneOf, InputValue, ListTicketsRequest, MessageEnvelope, Money, OnlineConferencingLogin, OrderStatus, OrderUpdated, StandardDetails, State, StreetAddress, Subdivision, SubdivisionType, Ticket, TicketDetails, TicketFacetCounts, TicketFacets, TicketFieldset, UpdateTicketRequest, WebhookIdentityType } from './index.typings.mjs';
 
+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`;
 declare function listTickets$1(httpClient: HttpClient): ListTicketsSignature;
 interface ListTicketsSignature {
     /**
@@ -10,10 +11,12 @@ interface ListTicketsSignature {
      * <!--
      * >**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 - Event IDs.
+     * @param - Event IDs to which the tickets belong.
      * @param - Options for defining the returned list of tickets.
      */
-    (eventId: string[], options?: ListTicketsOptions | undefined): Promise<ListTicketsResponse>;
+    (eventId: string[], options?: ListTicketsOptions): Promise<NonNullablePaths<ListTicketsResponse, `total` | `offset` | `limit` | {
+        [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+    }[TicketNonNullablePaths]>>;
 }
 declare function getTicket$1(httpClient: HttpClient): GetTicketSignature;
 interface GetTicketSignature {
@@ -23,7 +26,7 @@ interface GetTicketSignature {
      * @param - Options for the returned ticket data.
      * @returns Ticket.
      */
-    (identifiers: GetTicketIdentifiers, options?: GetTicketOptions | undefined): Promise<TicketingTicket>;
+    (identifiers: NonNullablePaths<GetTicketIdentifiers, `eventId` | `ticketNumber`>, options?: GetTicketOptions): Promise<NonNullablePaths<TicketingTicket, TicketNonNullablePaths>>;
 }
 declare function checkInTickets$1(httpClient: HttpClient): CheckInTicketsSignature;
 interface CheckInTicketsSignature {
@@ -32,7 +35,9 @@ interface CheckInTicketsSignature {
      * @param - Event ID to which the ticket belongs.
      * @param - Options for tickets to check-in.
      */
-    (eventId: string, options?: CheckInTicketsOptions | undefined): Promise<CheckInTicketResponse>;
+    (eventId: string, options?: CheckInTicketsOptions): Promise<NonNullablePaths<CheckInTicketResponse, {
+        [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+    }[TicketNonNullablePaths]>>;
 }
 declare function deleteTicketCheckIns$1(httpClient: HttpClient): DeleteTicketCheckInsSignature;
 interface DeleteTicketCheckInsSignature {
@@ -41,7 +46,9 @@ interface DeleteTicketCheckInsSignature {
      * @param - Event ID to which the ticket belongs.
      * @param - Options for tickets to delete.
      */
-    (eventId: string, options?: DeleteTicketCheckInsOptions | undefined): Promise<DeleteTicketCheckInResponse>;
+    (eventId: string, options?: DeleteTicketCheckInsOptions): Promise<NonNullablePaths<DeleteTicketCheckInResponse, {
+        [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+    }[TicketNonNullablePaths]>>;
 }
 declare function updateTicket$1(httpClient: HttpClient): UpdateTicketSignature;
 interface UpdateTicketSignature {
@@ -50,7 +57,9 @@ interface UpdateTicketSignature {
      * @param - Details for the ticket to update.
      * @param - Ticket details to update.
      */
-    (identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions | undefined): Promise<UpdateTicketResponse>;
+    (identifiers: NonNullablePaths<UpdateTicketIdentifiers, `eventId` | `ticketNumber`>, options?: UpdateTicketOptions): Promise<NonNullablePaths<UpdateTicketResponse, {
+        [P in TicketNonNullablePaths]: `ticket.${P}`;
+    }[TicketNonNullablePaths]>>;
 }
 declare function bulkUpdateTickets$1(httpClient: HttpClient): BulkUpdateTicketsSignature;
 interface BulkUpdateTicketsSignature {
@@ -59,7 +68,9 @@ interface BulkUpdateTicketsSignature {
      * @param - Options for updating the tickets.
      * @param - Event ID to which the ticket belongs.
      */
-    (eventId: string, options?: BulkUpdateTicketsOptions | undefined): Promise<BulkUpdateTicketsResponse>;
+    (eventId: string, options?: BulkUpdateTicketsOptions): Promise<NonNullablePaths<BulkUpdateTicketsResponse, {
+        [P in TicketNonNullablePaths]: `tickets.${number}.${P}`;
+    }[TicketNonNullablePaths]>>;
 }
 declare const onTicketOrderUpdated$1: EventDefinition<TicketOrderUpdatedEnvelope, "wix.events.ticketing.events.OrderUpdated">;