@wix/auto_sdk_events_ticket-definitions 1.0.40 → 1.0.42

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

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 interface TicketDefinition {
     /**
@@ -725,6 +725,23 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountDetails {
+    /**
+     * ID of the account.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the site, if applicable.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -900,7 +917,54 @@ interface DefinitionsQueryBuilder {
  * @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitionsV2
  * @requiredField query
  */
-declare function typedQueryTicketDefinitionsV2(query: QueryV2, options?: QueryTicketDefinitionsV2Options): Promise<NonNullablePaths<QueryTicketDefinitionsV2Response, `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`, 5>>;
+declare function typedQueryTicketDefinitionsV2(query: TicketDefinitionQuery, options?: QueryTicketDefinitionsV2Options): Promise<NonNullablePaths<QueryTicketDefinitionsV2Response, `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`, 5>>;
+interface TicketDefinitionQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [];
+}
+type CommonQueryWithEntityContext = Query<TicketDefinition, TicketDefinitionQuerySpec>;
+type TicketDefinitionQuery = {
+    /**
+    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?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * **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**.
@@ -1162,4 +1226,4 @@ interface ChangeCurrencyOptions {
     currency: string;
 }
 
-export { type BaseEventMetadata, type BulkCopyTicketDefinitionsByEventIdRequest, type BulkCopyTicketDefinitionsByEventIdResponse, type ById, type ChangeCurrencyOptions, type ChangeCurrencyRequest, type ChangeCurrencyResponse, type CopiedTicketDefinition, type CreateTicketDefinitionOptions, type CreateTicketDefinitionRequest, type CreateTicketDefinitionResponse, type CursorPaging, type Cursors, type Dashboard, type DefinitionsQueryBuilder, type DefinitionsQueryResult, type DeleteTicketDefinitionOptions, type DeleteTicketDefinitionOptionsDeleteOneOf, type DeleteTicketDefinitionRequest, type DeleteTicketDefinitionRequestDeleteOneOf, type DeleteTicketDefinitionResponse, type FacetCounts, FeeType, type FeeTypeWithLiterals, type GetTicketDefinitionOptions, type GetTicketDefinitionRequest, type GetTicketDefinitionResponse, GroupBy, type GroupByWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type ListTicketDefinitionsOptions, type ListTicketDefinitionsRequest, type ListTicketDefinitionsResponse, type MessageEnvelope, type Money, type OriginatedFrom, type Paging, type PagingMetadataV2, type PaidTicketDefinitionExistsRequest, type PaidTicketDefinitionExistsResponse, type PricingOption, type PricingOptions, type QueryTicketDefinitionsOptions, type QueryTicketDefinitionsRequest, type QueryTicketDefinitionsResponse, type QueryTicketDefinitionsV2Options, type QueryTicketDefinitionsV2Request, type QueryTicketDefinitionsV2Response, type QueryV2, type QueryV2PagingMethodOneOf, type ResponseMetaData, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type TicketDefinition, type TicketDefinitionCreated, type TicketDefinitionCreatedEnvelope, type TicketDefinitionData, type TicketDefinitionDeleted, type TicketDefinitionDeletedEnvelope, TicketDefinitionFieldset, type TicketDefinitionFieldsetWithLiterals, TicketDefinitionStateEnumState, type TicketDefinitionStateEnumStateWithLiterals, type TicketDefinitionUpdated, type TicketDefinitionUpdatedEnvelope, type TicketPricing, type TicketPricingPriceOneOf, type TicketSalePeriod, TicketSaleStatus, type TicketSaleStatusWithLiterals, Type, type TypeWithLiterals, type UpdateTicketDefinitionOptions, type UpdateTicketDefinitionRequest, type UpdateTicketDefinitionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixFeeConfig, changeCurrency, createTicketDefinition, deleteTicketDefinition, getTicketDefinition, listTicketDefinitions, onTicketDefinitionCreated, onTicketDefinitionDeleted, onTicketDefinitionUpdated, queryTicketDefinitions, queryTicketDefinitionsV2, typedQueryTicketDefinitionsV2, updateTicketDefinition };
+export { type AccountDetails, type BaseEventMetadata, type BulkCopyTicketDefinitionsByEventIdRequest, type BulkCopyTicketDefinitionsByEventIdResponse, type ById, type ChangeCurrencyOptions, type ChangeCurrencyRequest, type ChangeCurrencyResponse, type CommonQueryWithEntityContext, type CopiedTicketDefinition, type CreateTicketDefinitionOptions, type CreateTicketDefinitionRequest, type CreateTicketDefinitionResponse, type CursorPaging, type Cursors, type Dashboard, type DefinitionsQueryBuilder, type DefinitionsQueryResult, type DeleteTicketDefinitionOptions, type DeleteTicketDefinitionOptionsDeleteOneOf, type DeleteTicketDefinitionRequest, type DeleteTicketDefinitionRequestDeleteOneOf, type DeleteTicketDefinitionResponse, type FacetCounts, FeeType, type FeeTypeWithLiterals, type GetTicketDefinitionOptions, type GetTicketDefinitionRequest, type GetTicketDefinitionResponse, GroupBy, type GroupByWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type ListTicketDefinitionsOptions, type ListTicketDefinitionsRequest, type ListTicketDefinitionsResponse, type MessageEnvelope, type Money, type OriginatedFrom, type Paging, type PagingMetadataV2, type PaidTicketDefinitionExistsRequest, type PaidTicketDefinitionExistsResponse, type PricingOption, type PricingOptions, type QueryTicketDefinitionsOptions, type QueryTicketDefinitionsRequest, type QueryTicketDefinitionsResponse, type QueryTicketDefinitionsV2Options, type QueryTicketDefinitionsV2Request, type QueryTicketDefinitionsV2Response, type QueryV2, type QueryV2PagingMethodOneOf, type ResponseMetaData, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type TicketDefinition, type TicketDefinitionCreated, type TicketDefinitionCreatedEnvelope, type TicketDefinitionData, type TicketDefinitionDeleted, type TicketDefinitionDeletedEnvelope, TicketDefinitionFieldset, type TicketDefinitionFieldsetWithLiterals, type TicketDefinitionQuery, type TicketDefinitionQuerySpec, TicketDefinitionStateEnumState, type TicketDefinitionStateEnumStateWithLiterals, type TicketDefinitionUpdated, type TicketDefinitionUpdatedEnvelope, type TicketPricing, type TicketPricingPriceOneOf, type TicketSalePeriod, TicketSaleStatus, type TicketSaleStatusWithLiterals, Type, type TypeWithLiterals, type UpdateTicketDefinitionOptions, type UpdateTicketDefinitionRequest, type UpdateTicketDefinitionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixFeeConfig, changeCurrency, createTicketDefinition, deleteTicketDefinition, getTicketDefinition, listTicketDefinitions, onTicketDefinitionCreated, onTicketDefinitionDeleted, onTicketDefinitionUpdated, queryTicketDefinitions, queryTicketDefinitionsV2, typedQueryTicketDefinitionsV2, updateTicketDefinition };