@wix/auto_sdk_events_ticket-definitions 1.0.9 → 1.0.11

package/build/{events-v1-ticket-definition-ticket-definitions.universal-DjrTBlvE.d.mts → cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts}

@@ -1,4 +1,5 @@
-interface TicketDefinition {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface TicketDefinition {
     /**
      * Ticket definition ID.
      * @format GUID
@@ -46,7 +47,7 @@ interface TicketDefinition {
     /** Ticket pricing. */
     pricing?: TicketPricing;
 }
-interface Money {
+export interface Money {
     /**
      * Three-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
@@ -59,7 +60,7 @@ interface Money {
      */
     value?: string | null;
 }
-interface Dashboard {
+export interface Dashboard {
     /** Whether ticket is hidden and cannot be sold. */
     hidden?: boolean;
     /**
@@ -78,7 +79,7 @@ interface Dashboard {
     /** Number of tickets reserved. */
     ticketsReserved?: number;
 }
-interface WixFeeConfig {
+export interface WixFeeConfig {
     /**
      * Fee calculation method.
      *
@@ -88,7 +89,7 @@ interface WixFeeConfig {
      */
     type?: FeeType;
 }
-declare enum FeeType {
+export declare enum FeeType {
     /** Fee is added to the ticket price at checkout. */
     FEE_ADDED = "FEE_ADDED",
     /** Seller absorbs the fee. It is deducted from the ticket price. */
@@ -96,7 +97,7 @@ declare enum FeeType {
     /** Fee is added to the ticket price at checkout. */
     FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
 }
-interface TicketSalePeriod {
+export interface TicketSalePeriod {
     /** Ticket sale start timestamp. */
     startDate?: Date | null;
     /** Ticket sale end timestamp. */
@@ -104,7 +105,7 @@ interface TicketSalePeriod {
     /** Whether to hide this ticket if it's not on sale */
     hideNotOnSale?: boolean;
 }
-declare enum TicketSaleStatus {
+export declare enum TicketSaleStatus {
     /** Ticket sale is scheduled to start. */
     SALE_SCHEDULED = "SALE_SCHEDULED",
     /** Ticket sale has started. */
@@ -112,10 +113,10 @@ declare enum TicketSaleStatus {
     /** Ticket sale has ended. */
     SALE_ENDED = "SALE_ENDED"
 }
-declare enum TicketDefinitionStateEnumState {
+export declare enum TicketDefinitionStateEnumState {
     INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
 }
-interface TicketPricing extends TicketPricingPriceOneOf {
+export interface TicketPricing extends TicketPricingPriceOneOf {
     /** Ticket price which is read only. */
     fixedPrice?: Money;
     /** Min price per ticket, customizable. */
@@ -129,7 +130,7 @@ interface TicketPricing extends TicketPricingPriceOneOf {
     pricingType?: Type;
 }
 /** @oneof */
-interface TicketPricingPriceOneOf {
+export interface TicketPricingPriceOneOf {
     /** Ticket price which is read only. */
     fixedPrice?: Money;
     /** Min price per ticket, customizable. */
@@ -137,11 +138,11 @@ interface TicketPricingPriceOneOf {
     /** Ticket pricing options. */
     pricingOptions?: PricingOptions;
 }
-interface PricingOptions {
+export interface PricingOptions {
     /** Multiple ticket pricing options. */
     options?: PricingOption[];
 }
-interface PricingOption {
+export interface PricingOption {
     /**
      * Ticket pricing option ID.
      * @format GUID
@@ -156,11 +157,11 @@ interface PricingOption {
     /** Ticket pricing option price. */
     price?: Money;
 }
-declare enum Type {
+export declare enum Type {
     STANDARD = "STANDARD",
     DONATION = "DONATION"
 }
-interface QueryTicketDefinitionsRequest {
+export interface QueryTicketDefinitionsRequest {
     /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number;
     /**
@@ -189,13 +190,13 @@ interface QueryTicketDefinitionsRequest {
      */
     facet?: string[];
 }
-declare enum TicketDefinitionFieldset {
+export declare enum TicketDefinitionFieldset {
     /** Include `policy` in the response. */
     POLICY = "POLICY",
     /** Include `dashboard` in the response. */
     DASHBOARD = "DASHBOARD"
 }
-interface QueryTicketDefinitionsResponse {
+export interface QueryTicketDefinitionsResponse {
     /** Total ticket definitions matching the given filters. */
     total?: number;
     /** Offset. */
@@ -210,15 +211,15 @@ interface QueryTicketDefinitionsResponse {
     /** Filter facets. */
     facets?: Record<string, FacetCounts>;
 }
-interface FacetCounts {
+export interface FacetCounts {
     /** Facet counts aggregated per value. */
     counts?: Record<string, number>;
 }
-interface QueryTicketDefinitionsV2Request {
+export interface QueryTicketDefinitionsV2Request {
     /** Query request object. */
     query?: QueryV2;
 }
-interface QueryV2 extends QueryV2PagingMethodOneOf {
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -241,13 +242,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
     fieldsets?: string[];
 }
 /** @oneof */
-interface QueryV2PagingMethodOneOf {
+export interface QueryV2PagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -256,17 +257,17 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface Paging {
+export interface Paging {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -281,13 +282,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryTicketDefinitionsV2Response {
+export interface QueryTicketDefinitionsV2Response {
     /** Ticket definitions. */
     definitions?: TicketDefinition[];
     /** Paging metadata definitions. */
     metadata?: PagingMetadataV2;
 }
-interface PagingMetadataV2 {
+export interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -299,7 +300,7 @@ interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -311,7 +312,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface ListTicketDefinitionsRequest {
+export interface ListTicketDefinitionsRequest {
     /**
      * Event ID.
      * @format GUID
@@ -369,7 +370,7 @@ interface ListTicketDefinitionsRequest {
      */
     facet?: string[];
 }
-declare enum State {
+export declare enum State {
     /** The ticket is available for purchase. */
     VISIBLE = "VISIBLE",
     /** The ticket is unavailable for purchase. */
@@ -379,7 +380,7 @@ declare enum State {
     /** The ticket price is greater than 0. */
     PAID = "PAID"
 }
-declare enum GroupBy {
+export declare enum GroupBy {
     /** No grouping. */
     NONE = "NONE",
     /** Groups by event created date with descending sorting. */
@@ -387,7 +388,7 @@ declare enum GroupBy {
     /** Groups by event created date with ascending sorting. */
     EVENT_CREATED_ASC = "EVENT_CREATED_ASC"
 }
-interface ListTicketDefinitionsResponse {
+export interface ListTicketDefinitionsResponse {
     /** Meta data. */
     metaData?: ResponseMetaData;
     /** Retrieved ticket definitions. */
@@ -395,7 +396,7 @@ interface ListTicketDefinitionsResponse {
     /** Filter facets. */
     facets?: Record<string, FacetCounts>;
 }
-interface ResponseMetaData {
+export interface ResponseMetaData {
     /** Number of items in the response. */
     count?: number;
     /** Offset of items. */
@@ -403,7 +404,7 @@ interface ResponseMetaData {
     /** Total number of matching items. */
     total?: number;
 }
-interface GetTicketDefinitionRequest {
+export interface GetTicketDefinitionRequest {
     /**
      * Ticket definition ID.
      * @format GUID
@@ -419,11 +420,11 @@ interface GetTicketDefinitionRequest {
      */
     fieldset?: TicketDefinitionFieldset[];
 }
-interface GetTicketDefinitionResponse {
+export interface GetTicketDefinitionResponse {
     /** Retrieved ticket definition. */
     definition?: TicketDefinition;
 }
-interface CreateTicketDefinitionRequest {
+export interface CreateTicketDefinitionRequest {
     /**
      * Event ID.
      * @format GUID
@@ -432,7 +433,7 @@ interface CreateTicketDefinitionRequest {
     /** Ticket definition data. */
     definition: TicketDefinitionData;
 }
-interface TicketDefinitionData {
+export interface TicketDefinitionData {
     /**
      * Ticket name.
      * @maxLength 30
@@ -469,11 +470,11 @@ interface TicketDefinitionData {
     /** Ticket pricing. */
     pricing?: TicketPricing;
 }
-interface CreateTicketDefinitionResponse {
+export interface CreateTicketDefinitionResponse {
     /** Created ticket definition. */
     definition?: TicketDefinition;
 }
-interface TicketDefinitionCreated {
+export interface TicketDefinitionCreated {
     /** Ticket Definition created timestamp in ISO UTC format. */
     timestamp?: Date | null;
     /**
@@ -489,7 +490,7 @@ interface TicketDefinitionCreated {
     /** Originated from. */
     originatedFrom?: OriginatedFrom;
 }
-interface OriginatedFrom {
+export interface OriginatedFrom {
     /**
      * Instance ID. Indicates the original app instance which current entity originated from.
      * @format GUID
@@ -506,7 +507,7 @@ interface OriginatedFrom {
      */
     entityId?: string;
 }
-interface UpdateTicketDefinitionRequest {
+export interface UpdateTicketDefinitionRequest {
     /**
      * Event ID.
      * @format GUID
@@ -522,11 +523,11 @@ interface UpdateTicketDefinitionRequest {
     /** Set of field paths, specifying which parts of ticket definition to update. */
     fields?: string[];
 }
-interface UpdateTicketDefinitionResponse {
+export interface UpdateTicketDefinitionResponse {
     /** Updated ticket definition. */
     definition?: TicketDefinition;
 }
-interface TicketDefinitionUpdated {
+export interface TicketDefinitionUpdated {
     /** Ticket definition updated timestamp in ISO UTC format. */
     timestamp?: Date | null;
     /**
@@ -540,7 +541,7 @@ interface TicketDefinitionUpdated {
      */
     eventId?: string;
 }
-interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
+export interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
     /** Ticket definitions to delete. */
     byId?: ById;
     /** Whether to delete all event tickets. */
@@ -552,13 +553,13 @@ interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDel
     eventId: string;
 }
 /** @oneof */
-interface DeleteTicketDefinitionRequestDeleteOneOf {
+export interface DeleteTicketDefinitionRequestDeleteOneOf {
     /** Ticket definitions to delete. */
     byId?: ById;
     /** Whether to delete all event tickets. */
     all?: boolean;
 }
-interface ById {
+export interface ById {
     /**
      * Ticket definition IDs.
      * @format GUID
@@ -567,9 +568,9 @@ interface ById {
      */
     definitionId?: string[];
 }
-interface DeleteTicketDefinitionResponse {
+export interface DeleteTicketDefinitionResponse {
 }
-interface TicketDefinitionDeleted {
+export interface TicketDefinitionDeleted {
     /** Ticket definition deleted timestamp in ISO UTC format. */
     timestamp?: Date | null;
     /**
@@ -583,7 +584,7 @@ interface TicketDefinitionDeleted {
      */
     eventId?: string;
 }
-interface ChangeCurrencyRequest {
+export interface ChangeCurrencyRequest {
     /**
      * Event ID.
      * @format GUID
@@ -596,9 +597,9 @@ interface ChangeCurrencyRequest {
      */
     currency: string;
 }
-interface ChangeCurrencyResponse {
+export interface ChangeCurrencyResponse {
 }
-interface BulkCopyTicketDefinitionsByEventIdRequest {
+export interface BulkCopyTicketDefinitionsByEventIdRequest {
     /** Origin instance ID. */
     originInstanceId?: string | null;
     /**
@@ -612,23 +613,23 @@ interface BulkCopyTicketDefinitionsByEventIdRequest {
      */
     targetEventId?: string;
 }
-interface BulkCopyTicketDefinitionsByEventIdResponse {
+export interface BulkCopyTicketDefinitionsByEventIdResponse {
     /** Copied ticket definitions. */
     definitions?: CopiedTicketDefinition[];
 }
-interface CopiedTicketDefinition {
+export interface CopiedTicketDefinition {
     /** Origin Ticket definition ID. */
     originTicketDefinitionId?: string;
     /** Ticket definition ID. */
     ticketDefinitionId?: string;
 }
-interface PaidTicketDefinitionExistsRequest {
+export interface PaidTicketDefinitionExistsRequest {
 }
-interface PaidTicketDefinitionExistsResponse {
+export interface PaidTicketDefinitionExistsResponse {
     /** Paid exists. */
     paidExists?: boolean;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -644,7 +645,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -669,7 +670,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -691,14 +692,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -712,19 +713,96 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface TicketDefinitionCreatedEnvelope {
+export interface TicketDefinitionCreatedEnvelope {
     data: TicketDefinitionCreated;
     metadata: BaseEventMetadata;
 }
-interface TicketDefinitionDeletedEnvelope {
+/** @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @webhook
+ * @eventType wix.events.ticketing.events.TicketDefinitionCreated
+ * @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
+ * @slug ticket_definition_created
+ */
+export declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
+export interface TicketDefinitionDeletedEnvelope {
     data: TicketDefinitionDeleted;
     metadata: BaseEventMetadata;
 }
-interface TicketDefinitionUpdatedEnvelope {
+/** @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @webhook
+ * @eventType wix.events.ticketing.events.TicketDefinitionDeleted
+ * @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
+ * @slug ticket_definition_deleted
+ */
+export declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
+export interface TicketDefinitionUpdatedEnvelope {
     data: TicketDefinitionUpdated;
     metadata: BaseEventMetadata;
 }
-interface QueryTicketDefinitionsOptions {
+/** @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @webhook
+ * @eventType wix.events.ticketing.events.TicketDefinitionUpdated
+ * @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
+ * @slug ticket_definition_updated
+ */
+export declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
+type TicketDefinitionNonNullablePaths = `_id` | `price.amount` | `price.currency` | `free` | `name` | `description` | `limitPerCheckout` | `orderIndex` | `policy` | `dashboard.hidden` | `dashboard.sold` | `dashboard.limited` | `dashboard.ticketsSold` | `dashboard.ticketsReserved` | `eventId` | `wixFeeConfig.type` | `salePeriod.hideNotOnSale` | `saleStatus` | `state` | `pricing.fixedPrice.amount` | `pricing.fixedPrice.currency` | `pricing.pricingOptions.options` | `pricing.pricingType`;
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) function instead.
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinition()`](/ticket-definitions-v2/query-ticket-definitions).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinition()`, and replace it with `ticketDefinitionsV2.queryTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Retrieves a list of up to 100 ticket definitions.
+ * @public
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitions
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): Promise<NonNullablePaths<QueryTicketDefinitionsResponse, `total` | `offset` | `limit` | {
+    [P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
+}[TicketDefinitionNonNullablePaths]>>;
+export interface QueryTicketDefinitionsOptions {
     /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number;
     /**
@@ -753,7 +831,37 @@ interface QueryTicketDefinitionsOptions {
      */
     facet?: string[];
 }
-interface QueryTicketDefinitionsV2Options {
+/**
+ * **Deprecated.** This function will continue to work until October 29, 2024, but a newer version is available at [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Retrieves a list of up to 1,000 ticket definitions, given the provided paging and filtering.
+ * @public
+ * @documentationMaturity preview
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitionsV2
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function queryTicketDefinitionsV2(options?: QueryTicketDefinitionsV2Options): DefinitionsQueryBuilder;
+export interface QueryTicketDefinitionsV2Options {
 }
 interface QueryCursorResult {
     cursors: Cursors;
@@ -762,13 +870,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface DefinitionsQueryResult extends QueryCursorResult {
+export interface DefinitionsQueryResult extends QueryCursorResult {
     items: TicketDefinition[];
     query: DefinitionsQueryBuilder;
     next: () => Promise<DefinitionsQueryResult>;
     prev: () => Promise<DefinitionsQueryResult>;
 }
-interface DefinitionsQueryBuilder {
+export interface DefinitionsQueryBuilder {
     /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
      * @documentationMaturity preview
      */
@@ -780,7 +888,39 @@ interface DefinitionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<DefinitionsQueryResult>;
 }
-interface ListTicketDefinitionsOptions {
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a substitute is available. Use the [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) function instead.
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Retrieves a list of up to 100 ticket definitions, with basic filter support.
+ * @public
+ * @param options - Details for the tickets to retrieve.
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.ListTicketDefinitions
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise<NonNullablePaths<ListTicketDefinitionsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | {
+    [P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
+}[TicketDefinitionNonNullablePaths]>>;
+export interface ListTicketDefinitionsOptions {
     /**
      * Event ID.
      * @format GUID
@@ -843,7 +983,40 @@ interface ListTicketDefinitionsOptions {
      */
     facet?: string[];
 }
-interface GetTicketDefinitionOptions {
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition) function instead.
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.getTicketDefinition()`, and replace it with `ticketDefinitionsV2.getTicketDefinition()`. Update your code to work with the new `getTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Retrieves a ticket definition.
+ * @param definitionId - Ticket definition ID.
+ * @public
+ * @requiredField definitionId
+ * @param options - Details for the ticket to retrieve.
+ * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @returns Retrieved ticket definition.
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.GetTicketDefinition
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function getTicketDefinition(definitionId: string, options?: GetTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
+export interface GetTicketDefinitionOptions {
     /**
      * Predefined sets of fields to return.
      * - `DASHBOARD`: Returns `dashboard`.
@@ -854,30 +1027,162 @@ interface GetTicketDefinitionOptions {
      */
     fieldset?: TicketDefinitionFieldset[];
 }
-interface CreateTicketDefinitionOptions {
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`createTicketDefinition()`](/ticket-definitions-v2/create-ticket-definition) function instead.
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`createTicketDefinition()`](/ticket-definitions-v2/create-ticket-definition).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.createTicketDefinition()`, and replace it with `ticketDefinitionsV2.createTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Creates a ticket definition (and enables ticket sales).
+ * @param eventId - Event ID.
+ * @public
+ * @requiredField eventId
+ * @requiredField options
+ * @requiredField options.definition
+ * @requiredField options.definition.name
+ * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.CreateTicketDefinition
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function createTicketDefinition(eventId: string, options: NonNullablePaths<CreateTicketDefinitionOptions, `definition` | `definition.name`>): Promise<NonNullablePaths<CreateTicketDefinitionResponse, {
+    [P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
+}[TicketDefinitionNonNullablePaths]>>;
+export interface CreateTicketDefinitionOptions {
     /** Ticket definition data. */
     definition: TicketDefinitionData;
 }
-interface UpdateTicketDefinitionOptions {
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`updateTicketDefinition()`](/ticket-definitions-v2/update-ticket-definition) function instead.
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`updateTicketDefinition()`](/ticket-definitions-v2/update-ticket-definition).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.updateTicketDefinition()`, and replace it with `ticketDefinitionsV2.updateTicketDefinition()`. Update your code to work with the new `updateTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ *
+ * Updates a ticket definition.
+ *
+ * See [Partial Updates](/wix-events-v2/partial-updates) for more information.
+ * @param definitionId - Ticket definition ID.
+ * @param eventId - Event ID.
+ * @public
+ * @requiredField definitionId
+ * @requiredField eventId
+ * @requiredField options.definition.pricing.price
+ * @param identifiers - Details of the ticket definition to update.
+ * @param options - Ticket definition details to update.
+ * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.UpdateTicketDefinition
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function updateTicketDefinition(definitionId: string, eventId: string, options?: NonNullablePaths<UpdateTicketDefinitionOptions, `definition.pricing`>): Promise<NonNullablePaths<UpdateTicketDefinitionResponse, {
+    [P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
+}[TicketDefinitionNonNullablePaths]>>;
+export interface UpdateTicketDefinitionOptions {
     /** Ticket definition data. */
     definition?: TicketDefinitionData;
     /** Set of field paths, specifying which parts of ticket definition to update. */
     fields?: string[];
 }
-interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition) function instead.
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.deleteTicketDefinition()`, and replace it with `ticketDefinitionsV2.deleteTicketDefinition()`. Update your code to work with the new `deleteTicketDefinition()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Deletes a ticket definition.
+ * @param eventId - Event ID.
+ * @public
+ * @requiredField eventId
+ * @param options - Details of tickets to delete.
+ * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.DeleteTicketDefinition
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise<void>;
+export interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
     /** Ticket definitions to delete. */
     byId?: ById;
     /** Whether to delete all event tickets. */
     all?: boolean;
 }
 /** @oneof */
-interface DeleteTicketDefinitionOptionsDeleteOneOf {
+export interface DeleteTicketDefinitionOptionsDeleteOneOf {
     /** Ticket definitions to delete. */
     byId?: ById;
     /** Whether to delete all event tickets. */
     all?: boolean;
 }
-interface ChangeCurrencyOptions {
+/**
+ * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](/ticket-definitions-v2/change-currency).
+ * >**Migration Instructions**.
+ * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`changeCurrency()`](/ticket-definitions-v2/change-currency).
+ * > To migrate to the new function:
+ * > 1. Add the new import statement:
+ * > ```js
+ * > import { ticketDefinitionsV2 } from 'wix-events.v2';
+ * > ```
+ * > 2. Look for any code that uses `ticketDefinitions.changeCurrency()`, and replace it with `ticketDefinitionsV2.changeCurrency()`. Update your code to work with the new `changeCurrency()` response properties.
+ * > 3. Test your changes to make sure your code behaves as expected.
+ *
+ * Changes the currency for all tickets per event.
+ *
+ * @public
+ * @requiredField options.currency
+ * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Ticket Definitions
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.TicketDefinitionManagement.ChangeCurrency
+ * @deprecated
+ * @targetRemovalDate 2024-12-01
+ */
+export declare function changeCurrency(options?: NonNullablePaths<ChangeCurrencyOptions, `currency`>): Promise<void>;
+export interface ChangeCurrencyOptions {
     /**
      * Event ID.
      * @format GUID
@@ -890,5 +1195,4 @@ interface ChangeCurrencyOptions {
      */
     currency: string;
 }
-
-export { type DeleteTicketDefinitionRequestDeleteOneOf as $, type CursorPaging as A, type QueryTicketDefinitionsV2Response as B, type CreateTicketDefinitionOptions as C, type DefinitionsQueryBuilder as D, type PagingMetadataV2 as E, FeeType as F, type GetTicketDefinitionOptions as G, type Cursors as H, type ListTicketDefinitionsRequest as I, type GetTicketDefinitionRequest as J, type GetTicketDefinitionResponse as K, type ListTicketDefinitionsOptions as L, type Money as M, type CreateTicketDefinitionRequest as N, type TicketDefinitionData as O, type PricingOptions as P, type QueryTicketDefinitionsOptions as Q, type ResponseMetaData as R, SortOrder as S, type TicketDefinition as T, type UpdateTicketDefinitionOptions as U, type TicketDefinitionCreated as V, WebhookIdentityType as W, type OriginatedFrom as X, type UpdateTicketDefinitionRequest as Y, type TicketDefinitionUpdated as Z, type DeleteTicketDefinitionRequest as _, type QueryTicketDefinitionsResponse as a, type ById as a0, type DeleteTicketDefinitionResponse as a1, type TicketDefinitionDeleted as a2, type ChangeCurrencyRequest as a3, type ChangeCurrencyResponse as a4, type BulkCopyTicketDefinitionsByEventIdRequest as a5, type BulkCopyTicketDefinitionsByEventIdResponse as a6, type CopiedTicketDefinition as a7, type PaidTicketDefinitionExistsRequest as a8, type PaidTicketDefinitionExistsResponse as a9, type MessageEnvelope as aa, type IdentificationData as ab, type IdentificationDataIdOneOf as ac, type BaseEventMetadata as ad, type TicketDefinitionCreatedEnvelope as ae, type TicketDefinitionDeletedEnvelope as af, type TicketDefinitionUpdatedEnvelope as ag, type DefinitionsQueryResult as ah, type DeleteTicketDefinitionOptionsDeleteOneOf as ai, type QueryTicketDefinitionsV2Options as b, type ListTicketDefinitionsResponse as c, type CreateTicketDefinitionResponse as d, type UpdateTicketDefinitionResponse as e, type DeleteTicketDefinitionOptions as f, type ChangeCurrencyOptions as g, TicketSaleStatus as h, TicketDefinitionStateEnumState as i, Type as j, TicketDefinitionFieldset as k, State as l, GroupBy as m, type Dashboard as n, type WixFeeConfig as o, type TicketSalePeriod as p, type TicketPricing as q, type TicketPricingPriceOneOf as r, type PricingOption as s, type QueryTicketDefinitionsRequest as t, type FacetCounts as u, type QueryTicketDefinitionsV2Request as v, type QueryV2 as w, type QueryV2PagingMethodOneOf as x, type Sorting as y, type Paging as z };
+export {};