{"id":"505ebb29-fd33-425d-a54f-82eb29985cb5","createdDate":"2024-05-30T13:04:59.223Z","updatedDate":"2024-05-30T13:04:59.223Z","resourceId":"2b21b183-475b-41fc-ba96-9a1719666415","sdk":{"schema":{"name":"velo-deps_wix-events.v2_ticket-definitions-v-2","fqn":"","slug":"velo-deps-wix-events-v2-ticket-definitions-v-2","typesMap":{"ChangeCurrencyOptions":{"name":"ChangeCurrencyOptions","fqn":"ChangeCurrencyOptions","slug":"change-currency-options","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format."}]},"CountAvailableTicketDefinitionsResponse":{"name":"CountAvailableTicketDefinitionsResponse","fqn":"CountAvailableTicketDefinitionsResponse","slug":"count-available-ticket-definitions-response","actions":[],"properties":[{"name":"facets","slug":"facets","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"REFERENCE","name":"FacetCounts","referenceFqn":"FacetCounts"}},"description":"Filter facets."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Metadata for the paginated results."}]},"FacetCounts":{"name":"FacetCounts","fqn":"FacetCounts","slug":"facet-counts","actions":[],"properties":[{"name":"counts","slug":"counts","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"number"}},"description":"Facet counts aggregated per value"}]},"PagingMetadataV2":{"name":"PagingMetadataV2","fqn":"PagingMetadataV2","slug":"paging-metadata-v2","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset that was requested."},{"name":"tooManyToCount","slug":"too-many-to-count","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Flag that indicates the server failed to calculate the `total` field."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to previous page in the list of results."}]},"CountAvailableTicketDefinitionsOptions":{"name":"CountAvailableTicketDefinitionsOptions","fqn":"CountAvailableTicketDefinitionsOptions","slug":"count-available-ticket-definitions-options","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`."}]},"CountTicketDefinitionsResponse":{"name":"CountTicketDefinitionsResponse","fqn":"CountTicketDefinitionsResponse","slug":"count-ticket-definitions-response","actions":[],"properties":[{"name":"facets","slug":"facets","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"REFERENCE","name":"FacetCounts","referenceFqn":"FacetCounts"}},"description":"Filter facets."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Metadata for the paginated results."}]},"CountTicketDefinitionsOptions":{"name":"CountTicketDefinitionsOptions","fqn":"CountTicketDefinitionsOptions","slug":"count-ticket-definitions-options","actions":[],"properties":[{"name":"facet","slug":"facet","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Parameters to count ticket definitions by.\n\n- Max: 20 facets."},{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`."}]},"TicketDefinition":{"name":"TicketDefinition","fqn":"TicketDefinition","slug":"ticket-definition","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Date and time when the ticket definition was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Date and time when the ticket definition was updated."},{"name":"actualLimit","slug":"actual-limit","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition description."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID to which the ticket definition belongs."},{"name":"feeType","slug":"fee-type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:\n- `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.\n- `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total."},{"name":"hidden","slug":"hidden","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this ticket definition is hidden to site visitors and can't be purchased."},{"name":"initialLimit","slug":"initial-limit","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead."},{"name":"limitPerCheckout","slug":"limit-per-checkout","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of tickets that can be purchased per checkout.
\n**Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field."},{"name":"limited","slug":"limited","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the ticket has a limited maximum quantity."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition name."},{"name":"policyText","slug":"policy-text","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition policy."},{"name":"pricingMethod","slug":"pricing-method","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PricingMethod","referenceFqn":"PricingMethod"},"description":"Ticket pricing method."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition."},{"name":"salePeriod","slug":"sale-period","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SalePeriod","referenceFqn":"SalePeriod"},"description":"Ticket sale period."},{"name":"saleStatus","slug":"sale-status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SaleStatusEnumStatus","referenceFqn":"SaleStatusEnumStatus"},"description":"Ticket sale status. Possible values:\n- `SALE_SCHEDULED`: Tickets are not on sale yet.\n- `SALE_STARTED`: Tickets are on sale.\n- `SALE_ENDED`: Tickets are not on sale."},{"name":"salesDetails","slug":"sales-details","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SalesDetails","referenceFqn":"SalesDetails"},"description":"Ticket sales information.
\n**Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request."}]},"Type":{"name":"Type","fqn":"Type","slug":"type","actions":[],"enumValues":["FEE_ADDED_AT_CHECKOUT","FEE_INCLUDED","NO_FEE","UNKNOWN_FEE_TYPE"],"properties":[]},"PricingMethod":{"name":"PricingMethod","fqn":"PricingMethod","slug":"pricing-method","actions":[],"oneofProperties":{"price":[{"name":"fixedPrice","slug":"fixed-price","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CommonMoney","referenceFqn":"CommonMoney"},"description":"Same ticket price for everyone."},{"name":"guestPrice","slug":"guest-price","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CommonMoney","referenceFqn":"CommonMoney"},"description":"Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout."},{"name":"pricingOptions","slug":"pricing-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PricingOptions","referenceFqn":"PricingOptions"},"description":"Sets of various ticket prices. For example, you can charge different prices for children and adults."}]},"properties":[{"name":"free","slug":"free","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field."},{"name":"pricingType","slug":"pricing-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PricingTypeEnumType","referenceFqn":"PricingTypeEnumType"},"description":"Ticket price type. Possible values:\n- `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`.\n- `DONATION`: All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method."}]},"CommonMoney":{"name":"CommonMoney","fqn":"CommonMoney","slug":"common-money","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD)."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative."}]},"PricingOptions":{"name":"PricingOptions","fqn":"PricingOptions","slug":"pricing-options","actions":[],"properties":[{"name":"optionDetails","slug":"option-details","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OptionDetails","referenceFqn":"OptionDetails"}},"description":"Ticket price option details."}]},"OptionDetails":{"name":"OptionDetails","fqn":"OptionDetails","slug":"option-details","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket price option name, such as \"Child Ticket\"."},{"name":"optionId","slug":"option-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket price option ID."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CommonMoney","referenceFqn":"CommonMoney"},"description":"Ticket price."}]},"PricingTypeEnumType":{"name":"PricingTypeEnumType","fqn":"PricingTypeEnumType","slug":"pricing-type-enum-type","actions":[],"enumValues":["DONATION","STANDARD","UNKNOWN_PRICING_TYPE"],"properties":[]},"SalePeriod":{"name":"SalePeriod","fqn":"SalePeriod","slug":"sale-period","actions":[],"properties":[{"name":"displayNotOnSale","slug":"display-not-on-sale","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to display the ticket if it's not available to buy."},{"name":"endDate","slug":"end-date","isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Ticket sale end timestamp."},{"name":"startDate","slug":"start-date","isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Ticket sale start timestamp."}]},"SaleStatusEnumStatus":{"name":"SaleStatusEnumStatus","fqn":"SaleStatusEnumStatus","slug":"sale-status-enum-status","actions":[],"enumValues":["SALE_ENDED","SALE_SCHEDULED","SALE_STARTED","UNKNOWN_SALE_STATUS"],"properties":[]},"SalesDetails":{"name":"SalesDetails","fqn":"SalesDetails","slug":"sales-details","actions":[],"properties":[{"name":"reservedCount","slug":"reserved-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of reserved tickets."},{"name":"soldCount","slug":"sold-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of purchased tickets."},{"name":"soldOut","slug":"sold-out","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the tickets are sold out."},{"name":"unsoldCount","slug":"unsold-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited."}]},"CreateTicketDefinitionOptions":{"name":"CreateTicketDefinitionOptions","fqn":"CreateTicketDefinitionOptions","slug":"create-ticket-definition-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"}},"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`."}]},"Field":{"name":"Field","fqn":"Field","slug":"field","actions":[],"enumValues":["SALES_DETAILS","UNKNOWN_REQUESTED_FIELD"],"properties":[]},"GetTicketDefinitionOptions":{"name":"GetTicketDefinitionOptions","fqn":"GetTicketDefinitionOptions","slug":"get-ticket-definition-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"}},"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`."}]},"TicketDefinitionsQueryBuilder":{"name":"TicketDefinitionsQueryBuilder","fqn":"TicketDefinitionsQueryBuilder","slug":"ticket-definitions-query-builder","actions":[{"name":"ascending","fqn":"TicketDefinitionsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query =\n ticketDefinitionsV2.queryAvailableTicketDefinitions.ascending('_id');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .ascending('_id')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `TicketDefinitionsQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"descending","fqn":"TicketDefinitionsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query =\n ticketDefinitionsV2.queryAvailableTicketDefinitions.descending('_id');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .descending('_id')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `TicketDefinitionsQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"eq","fqn":"TicketDefinitionsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.eq(\n '_id',\n 'some-id'\n);\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"exists","fqn":"TicketDefinitionsQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.exists(\n 'description',\n 'some-description'\n);\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .exists('description', 'some-description')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `TicketDefinitionsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned."},{"name":"find","fqn":"TicketDefinitionsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryResult","referenceFqn":"TicketDefinitionsQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.find();\n"},{"title":"Perform a `find` on a query","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid."},{"name":"ge","fqn":"TicketDefinitionsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.ge(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .ge('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than or equal to the specified value.\n\nThe `ge()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"gt","fqn":"TicketDefinitionsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.gt(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .gt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than the specified value.\n\nThe `gt()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"in","fqn":"TicketDefinitionsQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n\nThe `in()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"le","fqn":"TicketDefinitionsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.le(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .le('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than or equal to the specified value.\n\nThe `le()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"limit","fqn":"TicketDefinitionsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .limit(10)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"examples":[{"title":"Add a `limit` to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .limit(10)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result."},{"name":"lt","fqn":"TicketDefinitionsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.lt(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .lt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than the specified value.\n\nThe `le()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"ne","fqn":"TicketDefinitionsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = ticketDefinitionsV2.queryAvailableTicketDefinitions.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `TicketDefinitionsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"skipTo","fqn":"TicketDefinitionsQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n const nextCursor = results.cursors.next;\n return ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .skipTo(nextCursor)\n .find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n const prevCursor = results.cursors.prev;\n return ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .skipTo(prevCursor)\n .find();\n}\n"}],"actionParams":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"A pointer to specific record"}],"description":"Refines a query that skips to a specific record.\n\nThe `skipTo()` function refines a `TicketDefinitionsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.\n \nWhen using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed."}],"properties":[]},"TicketDefinitionsQueryResult":{"name":"TicketDefinitionsQueryResult","fqn":"TicketDefinitionsQueryResult","slug":"ticket-definitions-query-result","actions":[{"name":"hasNext","fqn":"TicketDefinitionsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `ticketDefinitionsV2` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"TicketDefinitionsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `ticketDefinitionsV2` to navigate the pages of a query result."},{"name":"next","fqn":"TicketDefinitionsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryResult","referenceFqn":"TicketDefinitionsQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .limit(1000)\n .find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](wix-events-v2.TicketDefinitions.TicketDefinitionsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `ticketDefinitionsV2` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `TicketDefinitionsQueryBuilder` may change."},{"name":"prev","fqn":"TicketDefinitionsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"TicketDefinitionsQueryResult","referenceFqn":"TicketDefinitionsQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](wix-events-v2.TicketDefinitions.TicketDefinitionsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `ticketDefinitionsV2` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change."}],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"examples":[{"title":"Get the query's cursors","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n const cursors = results.cursors;\n}\n"}],"type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Returns the query cursors.\n\n`cursors` returns the query's `next` and `prev` cursors."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TicketDefinition","referenceFqn":"TicketDefinition"}},"description":"Returns an array of `ticketDefinitionsV2` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](wix-events-v2.TicketDefinitions.TicketDefinitionsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `ticketDefinitionsV2` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).\nThe page size is defined by the [`limit()`](wix-events-v2.TicketDefinitions.TicketDefinitionsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `ticketDefinitionsV2` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](wix-events-v2.TicketDefinitions.TicketDefinitionsQueryBuilder#limit) in `TicketDefinitionsQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nexport async function myQueryFunction() {\n const results = await ticketDefinitionsV2\n .queryAvailableTicketDefinitions()\n .find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},"description":"Returns the `TicketDefinitionsQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `TicketDefinitionsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `TicketDefinitionsQueryBuilder`."}]},"QueryAvailableTicketDefinitionsOptions":{"name":"QueryAvailableTicketDefinitionsOptions","fqn":"QueryAvailableTicketDefinitionsOptions","slug":"query-available-ticket-definitions-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"}},"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`."}]},"QueryTicketDefinitionsResponse":{"name":"QueryTicketDefinitionsResponse","fqn":"QueryTicketDefinitionsResponse","slug":"query-ticket-definitions-response","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Metadata for the paginated results."},{"name":"ticketDefinitions","slug":"ticket-definitions","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TicketDefinition","referenceFqn":"TicketDefinition"}},"description":"List of ticket definitions."}]},"QueryV2":{"name":"QueryV2","fqn":"QueryV2","slug":"query-v2","actions":[],"oneofProperties":{"pagingMethod":[{"name":"cursorPaging","slug":"cursor-paging","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CursorPaging","referenceFqn":"CursorPaging"},"description":"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` parameters."},{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Paging","referenceFqn":"Paging"},"description":"Paging options to limit and skip the number of items."}]},"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\", \"fieldName2\":{\"$operator\":\"value2\"} }`.

**Example:**
`\"filter\" : { \"id\": \"2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5\", \"revision\": {\"$ne\":\"1\"} }`"},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"}},"description":"Sort object in the following format:
`[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`

**Example:**
`[{\"fieldName\":\"createdDate\",\"direction\":\"DESC\"}]`

See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information."}]},"CursorPaging":{"name":"CursorPaging","fqn":"CursorPaging","slug":"cursor-paging","actions":[],"properties":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Pointer to the next or previous page in the list of results.\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load per page."}]},"Paging":{"name":"Paging","fqn":"Paging","slug":"paging","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load per page."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the current sort order."}]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Defaults to `ASC`"}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"QueryTicketDefinitionsOptions":{"name":"QueryTicketDefinitionsOptions","fqn":"QueryTicketDefinitionsOptions","slug":"query-ticket-definitions-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"}},"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`."}]},"ReorderTicketDefinitionsOptions":{"name":"ReorderTicketDefinitionsOptions","fqn":"ReorderTicketDefinitionsOptions","slug":"reorder-ticket-definitions-options","actions":[],"oneofProperties":{"reorderTicketDefinitionsRequestReferenceDefinition":[{"name":"afterDefinitionId","slug":"after-definition-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Move the given `definitionId` after the referenced ticket definition."},{"name":"beforeDefinitionId","slug":"before-definition-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Move the given `definitionId` before the referenced ticket definition."}]},"properties":[{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."}]},"UpdateTicketDefinition":{"name":"UpdateTicketDefinition","fqn":"UpdateTicketDefinition","slug":"update-ticket-definition","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Date and time when the ticket definition was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Date and time when the ticket definition was updated."},{"name":"actualLimit","slug":"actual-limit","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition description."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID to which the ticket definition belongs."},{"name":"feeType","slug":"fee-type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:\n- `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.\n- `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total."},{"name":"hidden","slug":"hidden","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this ticket definition is hidden to site visitors and can't be purchased."},{"name":"initialLimit","slug":"initial-limit","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead."},{"name":"limitPerCheckout","slug":"limit-per-checkout","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of tickets that can be purchased per checkout.
\n**Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field."},{"name":"limited","slug":"limited","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the ticket has a limited maximum quantity."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition name."},{"name":"policyText","slug":"policy-text","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition policy."},{"name":"pricingMethod","slug":"pricing-method","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PricingMethod","referenceFqn":"PricingMethod"},"description":"Ticket pricing method."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition."},{"name":"salePeriod","slug":"sale-period","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SalePeriod","referenceFqn":"SalePeriod"},"description":"Ticket sale period."},{"name":"saleStatus","slug":"sale-status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SaleStatusEnumStatus","referenceFqn":"SaleStatusEnumStatus"},"description":"Ticket sale status. Possible values:\n- `SALE_SCHEDULED`: Tickets are not on sale yet.\n- `SALE_STARTED`: Tickets are on sale.\n- `SALE_ENDED`: Tickets are not on sale."},{"name":"salesDetails","slug":"sales-details","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SalesDetails","referenceFqn":"SalesDetails"},"description":"Ticket sales information.
\n**Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request."}]},"UpdateTicketDefinitionOptions":{"name":"UpdateTicketDefinitionOptions","fqn":"UpdateTicketDefinitionOptions","slug":"update-ticket-definition-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"}},"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`."}]}},"actions":[{"name":"bulkDeleteTicketDefinitionsByFilter","fqn":"bulkDeleteTicketDefinitionsByFilter","slug":"bulk-delete-ticket-definitions-by-filter","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["filter"],"permissions":["Manage Events - all permissions","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"bulkDeleteTicketDefinitionsByFilter example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function bulkDeleteTicketDefinitionsByFilter(filter) {\n try {\n const result = await ticketDefinitionsV2.bulkDeleteTicketDefinitionsByFilter(filter);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"bulkDeleteTicketDefinitionsByFilter example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedBulkDeleteTicketDefinitionsByFilter = elevate(ticketDefinitionsV2.bulkDeleteTicketDefinitionsByFilter);\n\nexport const bulkDeleteTicketDefinitionsByFilter = webMethod(\n Permissions.Anyone,\n async (filter) => {\n try {\n const result = await elevatedBulkDeleteTicketDefinitionsByFilter(filter);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.

**Example:**
`\"filter\" : { \"eventId\": \"3d3d5c04-ece0-45a8-85f0-11a58edaa192\" }`"}],"description":"Deletes multiple ticket definitions.\n\nAll ticket definitions that meet the specified `filter` criteria are deleted."},{"name":"changeCurrency","fqn":"changeCurrency","slug":"change-currency","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["eventId","options","options.currency"],"permissions":["Manage Events - all permissions","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"changeCurrency example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function changeCurrency(eventId, options) {\n try {\n const result = await ticketDefinitionsV2.changeCurrency(eventId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"changeCurrency example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedChangeCurrency = elevate(ticketDefinitionsV2.changeCurrency);\n\nexport const changeCurrency = webMethod(\n Permissions.Anyone,\n async (eventId, options) => {\n try {\n const result = await elevatedChangeCurrency(eventId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"ChangeCurrencyOptions","referenceFqn":"ChangeCurrencyOptions"},"description":"Optional fields."}],"description":"> **Note:** This function replaces the deprecated `changeCurrency()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/changecurrency).\n\nChanges ticket price currency per event."},{"name":"createTicketDefinition","fqn":"createTicketDefinition","slug":"create-ticket-definition","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["ticketDefinition","ticketDefinition.eventId","ticketDefinition.feeType","ticketDefinition.name","ticketDefinition.pricingMethod"],"permissions":["Manage Events - all permissions","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"TicketDefinition","referenceFqn":"TicketDefinition"},"description":"Created ticket definition."},"examples":[{"title":"createTicketDefinition example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function createTicketDefinition(ticketDefinition, options) {\n try {\n const result = await ticketDefinitionsV2.createTicketDefinition(ticketDefinition, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"createTicketDefinition example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateTicketDefinition = elevate(ticketDefinitionsV2.createTicketDefinition);\n\nexport const createTicketDefinition = webMethod(\n Permissions.Anyone,\n async (ticketDefinition, options) => {\n try {\n const result = await elevatedCreateTicketDefinition(ticketDefinition, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"ticketDefinition","slug":"ticket-definition","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"TicketDefinition","referenceFqn":"TicketDefinition"},"description":"Ticket definition info."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CreateTicketDefinitionOptions","referenceFqn":"CreateTicketDefinitionOptions"},"description":"Optional fields."}],"description":"> **Note:** This function replaces the deprecated `createTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/createticketdefinition).\n\n\nCreates a ticket definition.\n\n\nIt is allowed to create up to 100 definitions per event."},{"name":"deleteTicketDefinition","fqn":"deleteTicketDefinition","slug":"delete-ticket-definition","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["ticketDefinitionId"],"permissions":["Manage Events - all permissions","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"deleteTicketDefinition example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function deleteTicketDefinition(ticketDefinitionId) {\n try {\n const result = await ticketDefinitionsV2.deleteTicketDefinition(ticketDefinitionId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"deleteTicketDefinition example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteTicketDefinition = elevate(ticketDefinitionsV2.deleteTicketDefinition);\n\nexport const deleteTicketDefinition = webMethod(\n Permissions.Anyone,\n async (ticketDefinitionId) => {\n try {\n const result = await elevatedDeleteTicketDefinition(ticketDefinitionId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the ticket definition to delete."}],"description":"> **Note:** This function replaces the deprecated `deleteTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/deleteticketdefinition).\n\nPermanently deletes a ticket definition."},{"name":"getTicketDefinition","fqn":"getTicketDefinition","slug":"get-ticket-definition","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["ticketDefinitionId"],"permissions":["Manage Events - all permissions","Manage Orders","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-ORDERS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"TicketDefinition","referenceFqn":"TicketDefinition"},"description":"The requested ticket definition."},"examples":[{"title":"getTicketDefinition example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function getTicketDefinition(ticketDefinitionId, options) {\n try {\n const result = await ticketDefinitionsV2.getTicketDefinition(ticketDefinitionId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getTicketDefinition example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedGetTicketDefinition = elevate(ticketDefinitionsV2.getTicketDefinition);\n\nexport const getTicketDefinition = webMethod(\n Permissions.Anyone,\n async (ticketDefinitionId, options) => {\n try {\n const result = await elevatedGetTicketDefinition(ticketDefinitionId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"ticketDefinitionId","slug":"ticket-definition-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"GetTicketDefinitionOptions","referenceFqn":"GetTicketDefinitionOptions"},"description":"Optional fields."}],"description":"> **Note:** This function replaces the deprecated `getTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/getticketdefinition).\n\nRetrieves a ticket definition by ID."},{"name":"queryTicketDefinitions","fqn":"queryTicketDefinitions","slug":"query-ticket-definitions","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["query"],"permissions":["Manage Events - all permissions","Manage Orders","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-ORDERS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"QueryTicketDefinitionsResponse","referenceFqn":"QueryTicketDefinitionsResponse"}},"examples":[{"title":"queryTicketDefinitions example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function queryTicketDefinitions(query, options) {\n try {\n const result = await ticketDefinitionsV2.queryTicketDefinitions(query, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"queryTicketDefinitions example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedQueryTicketDefinitions = elevate(ticketDefinitionsV2.queryTicketDefinitions);\n\nexport const queryTicketDefinitions = webMethod(\n Permissions.Anyone,\n async (query, options) => {\n try {\n const result = await elevatedQueryTicketDefinitions(query, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"QueryV2","referenceFqn":"QueryV2"},"description":"Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"QueryTicketDefinitionsOptions","referenceFqn":"QueryTicketDefinitionsOptions"},"description":"Optional fields."}],"description":"> **Note:** This function replaces the deprecated `listTicketDefinition()` and `queryTicketDefinitions` functions. The deprecated functions will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/queryticketdefinitions).\n\nRetrieves a list of ticket definitions, given the provided paging, filtering, and sorting.\nQuery Ticket Definitions runs with these defaults, which you can override:\n- `createdDate` is sorted in `ASC` order\n- `paging.limit` is `100`\n- `paging.offset` is `0`"},{"name":"reorderTicketDefinitions","fqn":"reorderTicketDefinitions","slug":"reorder-ticket-definitions","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["eventId","options.ticketDefinitionId"],"permissions":["Manage Events - all permissions","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"reorderTicketDefinitions example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function reorderTicketDefinitions(eventId, options) {\n try {\n const result = await ticketDefinitionsV2.reorderTicketDefinitions(eventId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"reorderTicketDefinitions example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedReorderTicketDefinitions = elevate(ticketDefinitionsV2.reorderTicketDefinitions);\n\nexport const reorderTicketDefinitions = webMethod(\n Permissions.Anyone,\n async (eventId, options) => {\n try {\n const result = await elevatedReorderTicketDefinitions(eventId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"ReorderTicketDefinitionsOptions","referenceFqn":"ReorderTicketDefinitionsOptions"},"description":"Optional fields."}],"description":"Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.\n> **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed."},{"name":"updateTicketDefinition","fqn":"updateTicketDefinition","slug":"update-ticket-definition","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["_id","ticketDefinition","ticketDefinition.revision"],"permissions":["Manage Events - all permissions","Manage Ticket Definitions"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"TicketDefinition","referenceFqn":"TicketDefinition"},"description":"The updated ticket definition."},"examples":[{"title":"updateTicketDefinition example for dashboard page code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\n\nasync function updateTicketDefinition(id, ticketDefinition, options) {\n try {\n const result = await ticketDefinitionsV2.updateTicketDefinition(id, ticketDefinition, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"updateTicketDefinition example for exporting from backend code","content":"import { ticketDefinitionsV2 } from 'wix-events.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedUpdateTicketDefinition = elevate(ticketDefinitionsV2.updateTicketDefinition);\n\nexport const updateTicketDefinition = webMethod(\n Permissions.Anyone,\n async (id, ticketDefinition, options) => {\n try {\n const result = await elevatedUpdateTicketDefinition(id, ticketDefinition, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"ticketDefinition","slug":"ticket-definition","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"UpdateTicketDefinition","referenceFqn":"UpdateTicketDefinition"},"description":"Ticket definition to update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"UpdateTicketDefinitionOptions","referenceFqn":"UpdateTicketDefinitionOptions"},"description":"Optional fields."}],"description":"> **Note:** This function replaces the deprecated `updateTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/updateticketdefinition).\n\nUpdates a ticket definition.\n\n\nEach time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n# Introduction\n\nWith the Ticket Definitions v2 API, you can define tickets for your event. A definition includes the following ticket settings:\n\n- Fee type. Determine whether the fee will be paid by a guest or a seller.\n- Pricing. Define different ticket prices based on factors such as early bird discounts, VIP packages, group rates, or special promotions. Several pricing methods are available for you to select from: **Fixed price**, **Guest price**, **Free**. Additionally, you can customize prices for different groups of people using **Price options**.\n- Availability. Set the ticket limit available to buy. Also, you are able to check number of purchased or reserved tickets.\n- Sale period. Set the sale start and end dates. Also, when defining the sale period, it is possible to choose to display event tickets to customers even before the sale starts. \n\nWith the Ticket Definitions v2 API you can:\n\n- Create, delete, and update definitions.\n- Change the definitions order in an event dashboard and the list of available tickets in the ticket picker.\n- Get the information about ticket definitions.\n\n## Before you begin\n\nIt’s important to note the following points before starting to code: \n\n- Install the **Wix Events & Tickets** app from [Wix App Market](https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events).\n- Once you create a ticketed event, it cannot be updated to a RSVP event.\n- Ticket definition is not the same as ticket. Ticket definitions are used to define settings for a set of tickets. After paying for selected tickets, the [`checkout`](https://www.wix.com/velo/reference/wix-events-v2/orders/checkout) function automatically generates the ticket.\n- To use the Ticket Definitions v2 API, import `{ ticketDefinitionsV2 }` from the `wix-events.v2` module:\n\n```javascript\nimport { ticketDefinitionsV2 } from 'wix-events.v2';\n```\n\n## Terminology\n\n- **Pricing method**: Different pricing methods are available for an event:\n - **Fixed price**: All tickets in the same definition are sold at the exact same price, regardless of when they are purchased or other factors.\n - **Guest price**: A minimum price a guest must pay for a ticket. For example, money goes to donation.\n - **Price options**: All tickets in the same ticket definition are priced at different rates, such as different prices for adults, children, and students.\n- **Ticket availability**: The status of ticket inventory, indicating whether tickets are available or sold out. This type can also include availability limits and timeframes for ticket sales.\n- **Sale period**: Duration of time during which event tickets are available for purchase. \n- **Event Dashboard**: Control center in the Wix site UI for managing site event settings and features.","displayName":"Introduction","slugifyName":"introduction","fqn":"Introduction75"}],"builderTypes":[{"kind":"REFERENCE","name":"TicketDefinitionsQueryBuilder","referenceFqn":"TicketDefinitionsQueryBuilder"},{"kind":"REFERENCE","name":"TicketDefinitionsQueryResult","referenceFqn":"TicketDefinitionsQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.58"},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"TicketDefinitionsV2","yamlTitle":"Wix Events V 2","kind":"VELO","fqdn":"wix.events.v3.ticket_definition"}}