{"id":"c1ac24a9-70fb-4cad-91ab-bddba16d5146","createdDate":"2024-09-17T15:00:44.800Z","updatedDate":"2024-09-17T15:00:44.800Z","resourceId":"d0b3dc00-0cf2-49ff-ac43-3a3fa4a7b4dc","sdk":{"schema":{"name":"events_guests","fqn":"","slug":"events-guests","typesMap":{"QueryEventGuestsOptions":{"name":"QueryEventGuestsOptions","fqn":"QueryEventGuestsOptions","slug":"query-event-guests-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RequestedFieldsEnumRequestedFields","referenceFqn":"RequestedFieldsEnumRequestedFields"}},"description":"Predefined sets of fields to return.\n- `GUEST_DETAILS`: Returns `guestDetails` and `tickets`.\n- `GUEST_TOTAL`: Returns `totalGuests`."}]},"RequestedFieldsEnumRequestedFields":{"name":"RequestedFieldsEnumRequestedFields","fqn":"RequestedFieldsEnumRequestedFields","slug":"requested-fields-enum-requested-fields","actions":[],"enumValues":["GUEST_DETAILS","GUEST_TOTAL","UNKNOWN_REQUESTED_FIELD"],"properties":[]},"GuestsQueryBuilder":{"name":"GuestsQueryBuilder","fqn":"GuestsQueryBuilder","slug":"guests-query-builder","actions":[{"name":"ascending","fqn":"GuestsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = guests.queryGuests.ascending('_createdDate');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().ascending('_createdDate').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,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = guests.queryGuests.descending('_createdDate');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().descending('_createdDate').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,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = guests.queryGuests.eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = guests.queryGuests.exists('description', 'some-description');\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GuestsQueryResult","referenceFqn":"GuestsQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = guests.queryGuests.find();\n"},{"title":"Perform a `find` on a query","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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":"GuestsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = guests.queryGuests.ge('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = guests.queryGuests.gt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = guests.queryGuests.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = guests.queryGuests.le('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = guests.queryGuests.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().limit(10).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,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = guests.queryGuests.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().limit(10).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":"GuestsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = guests.queryGuests.lt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = guests.queryGuests.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests\n .queryGuests()\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,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":"GuestsQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().find();\n\n const nextCursor = results.cursors.next;\n return guests.queryGuests().skipTo(nextCursor).find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().find();\n\n const prevCursor = results.cursors.prev;\n return guests.queryGuests().skipTo(prevCursor).find();\n}\n"}],"actionParams":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","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 `GuestsQueryBuilder` 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":[]},"GuestsQueryResult":{"name":"GuestsQueryResult","fqn":"GuestsQueryResult","slug":"guests-query-result","actions":[{"name":"hasNext","fqn":"GuestsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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 `guests` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"GuestsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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 `guests` to navigate the pages of a query result."},{"name":"next","fqn":"GuestsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GuestsQueryResult","referenceFqn":"GuestsQueryResult"}},"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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await guests.queryGuests().limit(1000).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()`](/guests/guests-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `guests` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `GuestsQueryBuilder` may change."},{"name":"prev","fqn":"GuestsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GuestsQueryResult","referenceFqn":"GuestsQueryResult"}},"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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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()`](/guests/guests-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `guests` 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,"maturity":"GA","examples":[{"title":"Get the query's cursors","content":"import { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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,"maturity":"GA","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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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":"EventGuest","referenceFqn":"EventGuest"}},"description":"Returns an array of `guests` 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()`](/guests/guests-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `guests` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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()`](/guests/guests-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `guests` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().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()`](/guests/guests-query-builder/limit) in `GuestsQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","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 { guests } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await guests.queryGuests().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"description":"Returns the `GuestsQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `GuestsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `GuestsQueryBuilder`."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"EventGuest":{"name":"EventGuest","fqn":"EventGuest","slug":"event-guest","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest ID."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format."},{"name":"attendanceStatus","slug":"attendance-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AttendanceStatus","referenceFqn":"AttendanceStatus"},"description":"Attendance status. The attendaces status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping).

**Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable."},{"name":"attendanceStatusUpdatedDate","slug":"attendance-status-updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of guest's latest attendance status update."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"guestDetails","slug":"guest-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestDetails","referenceFqn":"GuestDetails"},"description":"Guest details.

Returned only when the `guestDetails` fieldset is sent in the request."},{"name":"guestType","slug":"guest-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestType","referenceFqn":"GuestType"},"description":"Guest type:

`RSVP`: An invited guest, no ticket necessary.

`BUYER`: The guest who bought the tickets.

`TICKET_HOLDER`: The guest for whom the ticket was bought."},{"name":"locale","slug":"locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Site member ID."},{"name":"orderNumber","slug":"order-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order number.

**Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the guest is updated."},{"name":"rsvpId","slug":"rsvp-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"RSVP ID.

**Note:** Only applicable when `guestType` is `RSVP`."},{"name":"secondaryLanguageCode","slug":"secondary-language-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language."},{"name":"ticketNumber","slug":"ticket-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket number.

**Note:** Only applicable when `guestType` is `TICKET_HOLDER`."},{"name":"tickets","slug":"tickets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TicketDetails","referenceFqn":"TicketDetails"}},"description":"List of names, numbers, and definition IDs for each ticket."},{"name":"totalGuests","slug":"total-guests","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of total guests in an event (registered guests + additional ones)."}]},"AttendanceStatus":{"name":"AttendanceStatus","fqn":"AttendanceStatus","slug":"attendance-status","actions":[],"enumValues":["ATTENDING","IN_WAITLIST","NOT_ATTENDING"],"properties":[]},"GuestDetails":{"name":"GuestDetails","fqn":"GuestDetails","slug":"guest-details","actions":[],"properties":[{"name":"checkedIn","slug":"checked-in","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the guest has checked into the event."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"formResponse","slug":"form-response","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormResponse","referenceFqn":"FormResponse"},"description":"Form response."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"onlineConferencingLogin","slug":"online-conferencing-login","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineConferencingLogin","referenceFqn":"OnlineConferencingLogin"},"description":"The login details for the guest to access the online conference event."}]},"FormResponse":{"name":"FormResponse","fqn":"FormResponse","slug":"form-response","actions":[],"properties":[{"name":"inputValues","slug":"input-values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InputValue","referenceFqn":"InputValue"}}}]},"InputValue":{"name":"InputValue","fqn":"InputValue","slug":"input-value","actions":[],"properties":[{"name":"inputName","slug":"input-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}}]},"OnlineConferencingLogin":{"name":"OnlineConferencingLogin","fqn":"OnlineConferencingLogin","slug":"online-conferencing-login","actions":[],"properties":[{"name":"link","slug":"link","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Link URL to the online conference."},{"name":"password","slug":"password","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Password for the online conference."}]},"GuestType":{"name":"GuestType","fqn":"GuestType","slug":"guest-type","actions":[],"enumValues":["BUYER","RSVP","TICKET_HOLDER"],"properties":[]},"TicketDetails":{"name":"TicketDetails","fqn":"TicketDetails","slug":"ticket-details","actions":[],"properties":[{"name":"definitionId","slug":"definition-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket definition ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Ticket number."}]},"OnGuestCreatedHandler":{"name":"OnGuestCreatedHandler","fqn":"OnGuestCreatedHandler","slug":"on-guest-created-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestCreatedEnvelope","referenceFqn":"GuestCreatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"GuestCreatedEnvelope":{"name":"GuestCreatedEnvelope","fqn":"GuestCreatedEnvelope","slug":"guest-created-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventGuest","referenceFqn":"EventGuest"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"EventMetadata":{"name":"EventMetadata","fqn":"EventMetadata","slug":"event-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks."},{"name":"entityEventSequence","slug":"entity-event-sequence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message."},{"name":"entityFqdn","slug":"entity-fqdn","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction"},{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z"},{"name":"eventType","slug":"event-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event type."},{"name":"identity","slug":"identity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"IdentificationData","referenceFqn":"IdentificationData"},"description":"The identification type and identity data."},{"name":"instanceId","slug":"instance-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App instance ID."},{"name":"originatedFrom","slug":"originated-from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"If present, indicates the action that triggered the event."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened"},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR)."}]},"IdentificationData":{"name":"IdentificationData","fqn":"IdentificationData","slug":"identification-data","actions":[],"oneofProperties":{"id":[{"name":"anonymousVisitorId","slug":"anonymous-visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a site visitor that has not logged in to the site."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of an app."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a site visitor that has logged in to the site."},{"name":"wixUserId","slug":"wix-user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a Wix user (site owner, contributor, etc.)."}]},"properties":[{"name":"identityType","slug":"identity-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WebhookIdentityType","referenceFqn":"WebhookIdentityType"}}]},"WebhookIdentityType":{"name":"WebhookIdentityType","fqn":"WebhookIdentityType","slug":"webhook-identity-type","actions":[],"enumValues":["ANONYMOUS_VISITOR","APP","MEMBER","UNKNOWN","WIX_USER"],"properties":[]},"OnGuestDeletedHandler":{"name":"OnGuestDeletedHandler","fqn":"OnGuestDeletedHandler","slug":"on-guest-deleted-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestDeletedEnvelope","referenceFqn":"GuestDeletedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"GuestDeletedEnvelope":{"name":"GuestDeletedEnvelope","fqn":"GuestDeletedEnvelope","slug":"guest-deleted-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventGuest","referenceFqn":"EventGuest"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"OnGuestUpdatedHandler":{"name":"OnGuestUpdatedHandler","fqn":"OnGuestUpdatedHandler","slug":"on-guest-updated-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GuestUpdatedEnvelope","referenceFqn":"GuestUpdatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"GuestUpdatedEnvelope":{"name":"GuestUpdatedEnvelope","fqn":"GuestUpdatedEnvelope","slug":"guest-updated-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventGuest","referenceFqn":"EventGuest"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.events.guests.v1.guest"},"actions":[{"name":"queryGuests","fqn":"queryGuests","slug":"query-guests","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["WIX_EVENTS.READ_GUESTS"],"permissions":["Read Events - all read permissions","Manage Events - all permissions","Manage Guest List","Read Event Tickets and Guest List"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.READ-EVENTS","SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-GUEST-LIST","SCOPE.DC-EVENTS.READ-GUEST-LIST"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},"examples":[{"title":"queryGuests: Wix-hosted","content":"import { guests } from '@wix/events';\n\nasync function queryGuests() {\n const { items } = await guests.queryGuests().find();\n};"},{"title":"queryGuests: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { guests } from '@wix/events';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { guests },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryGuests() {\n const { items } = await myWixClient.guests.queryGuests().find();\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryEventGuestsOptions","referenceFqn":"QueryEventGuestsOptions"}}],"description":"Creates a query to retrieve a list of guests.\n\n\nThe `queryGuests()` function builds a query to retrieve a list of guests and returns a [GuestsQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder) object.\n\nThe returned object contains the query definition which is typically used to run the query using the `find()` function.\n\nYou can refine the query by chaining `GuestsQueryBuilder` functions onto the query. `GuestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryGuests.find()` returns.\n\nThe query runs with the following `GuestsQueryBuilder` defaults that you can override:\n\n- [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/skipto)\n- [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/limit)\n- [`descending(\"_createdDate\")`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/descending)\n\nThe functions that are chained to `queryGuests()` are applied in the order they are called. For example, if you apply `ascending ('_createdDate')` and then `descending ('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.\n\nThe table below shows which `GuestsQueryBuilder` functions are supported for `queryGuests()`. You can only use one filter function for each property. Only the first filter will work if a property is used in more than one filter.\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`eventId`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`rsvpId`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`orderNumber`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`ticketNumber`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`tickets`|[`exists()`](/guests/guests-query-builder/exists)|\n|`contactId`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`guestDetails.checkedIn`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`exists()`](/guests/guests-query-builder/exists)|\n|`attendanceStatus`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in)|\n|`secondaryLanguageCode`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`_createdDate`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`lt()`](/guests/guests-query-builder/lt),[`le()`](/guests/guests-query-builder/le),[`gt()`](/guests/guests-query-builder/gt),[`ge()`](/guests/guests-query-builder/ge),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists),[`ascending()`](/guests/guests-query-builder/ascending),[`descending()`](/guests/guests-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`lt()`](/guests/guests-query-builder/lt),[`le()`](/guests/guests-query-builder/le),[`gt()`](/guests/guests-query-builder/gt),[`ge()`](/guests/guests-query-builder/ge),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists),[`ascending()`](/guests/guests-query-builder/ascending),[`descending()`](/guests/guests-query-builder/descending)|\n|`attendanceStatusUpdatedDate`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`lt()`](/guests/guests-query-builder/lt),[`le()`](/guests/guests-query-builder/le),[`gt()`](/guests/guests-query-builder/gt),[`ge()`](/guests/guests-query-builder/ge),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists),[`ascending()`](/guests/guests-query-builder/ascending),[`descending()`](/guests/guests-query-builder/descending)|\n|`memberId`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in),[`exists()`](/guests/guests-query-builder/exists)|\n|`guestType`|[`eq()`](/guests/guests-query-builder/eq),[`ne()`](/guests/guests-query-builder/ne),[`in()`](/guests/guests-query-builder/in)|","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Read Events - all read permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.READ-EVENTS"},{"name":"Manage Guest List","scopeId":"SCOPE.DC-EVENTS.MANAGE-GUEST-LIST"},{"name":"Read Event Tickets and Guest List","scopeId":"SCOPE.DC-EVENTS.READ-GUEST-LIST"}],"isAdminMethod":true}],"webhooks":[{"name":"onGuestCreated","fqn":"onGuestCreated","slug":"on-guest-created","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGuestCreatedHandler","referenceFqn":"OnGuestCreatedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a guest is created.","examples":[{"title":"onGuestCreated: Wix-hosted","content":"import { guests } from '@wix/events';\n\nguests.onGuestCreated((event) => {\n // handle your event here\n});"},{"title":"onGuestCreated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { guests } from '@wix/events';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n guests,\n },\n});\n\nwixClient.guests.onGuestCreated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_EVENTS.READ_GUESTS_DETAILS"],"permissions":["Read Events - all read permissions","Manage Events - all permissions","Manage Guest List","Read Event Tickets and Guest List"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.READ-EVENTS","SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-GUEST-LIST","SCOPE.DC-EVENTS.READ-GUEST-LIST"],"eventType":"wix.events.guests.v1.guest_created","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Read Events - all read permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.READ-EVENTS"},{"name":"Manage Guest List","scopeId":"SCOPE.DC-EVENTS.MANAGE-GUEST-LIST"},{"name":"Read Event Tickets and Guest List","scopeId":"SCOPE.DC-EVENTS.READ-GUEST-LIST"}]},{"name":"onGuestDeleted","fqn":"onGuestDeleted","slug":"on-guest-deleted","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGuestDeletedHandler","referenceFqn":"OnGuestDeletedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a guest is deleted.","examples":[{"title":"onGuestDeleted: Wix-hosted","content":"import { guests } from '@wix/events';\n\nguests.onGuestDeleted((event) => {\n // handle your event here\n});"},{"title":"onGuestDeleted: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { guests } from '@wix/events';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n guests,\n },\n});\n\nwixClient.guests.onGuestDeleted((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_EVENTS.READ_GUESTS_DETAILS"],"permissions":["Read Events - all read permissions","Manage Events - all permissions","Manage Guest List","Read Event Tickets and Guest List"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.READ-EVENTS","SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-GUEST-LIST","SCOPE.DC-EVENTS.READ-GUEST-LIST"],"eventType":"wix.events.guests.v1.guest_deleted","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Read Events - all read permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.READ-EVENTS"},{"name":"Manage Guest List","scopeId":"SCOPE.DC-EVENTS.MANAGE-GUEST-LIST"},{"name":"Read Event Tickets and Guest List","scopeId":"SCOPE.DC-EVENTS.READ-GUEST-LIST"}]},{"name":"onGuestUpdated","fqn":"onGuestUpdated","slug":"on-guest-updated","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGuestUpdatedHandler","referenceFqn":"OnGuestUpdatedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a guest is updated. This webhook always fires together with [Event Guest Created](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-created) and [Event Guest Deleted](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-deleted) webhooks. When calling it, it might be triggered twice - make sure to explicitly add code to make sure parts of your code only run once.","examples":[{"title":"onGuestUpdated: Wix-hosted","content":"import { guests } from '@wix/events';\n\nguests.onGuestUpdated((event) => {\n // handle your event here\n});"},{"title":"onGuestUpdated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { guests } from '@wix/events';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n guests,\n },\n});\n\nwixClient.guests.onGuestUpdated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_EVENTS.READ_GUESTS_DETAILS"],"permissions":["Read Events - all read permissions","Manage Events - all permissions","Manage Guest List","Read Event Tickets and Guest List"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.READ-EVENTS","SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-GUEST-LIST","SCOPE.DC-EVENTS.READ-GUEST-LIST"],"eventType":"wix.events.guests.v1.guest_updated","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Read Events - all read permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.READ-EVENTS"},{"name":"Manage Guest List","scopeId":"SCOPE.DC-EVENTS.MANAGE-GUEST-LIST"},{"name":"Read Event Tickets and Guest List","scopeId":"SCOPE.DC-EVENTS.READ-GUEST-LIST"}]}],"articles":[{"content":"# Introduction\n\nWith the Event Guests API, site owners can get information about all guests who bought tickets to an event or who RSVP'ed. The information includes guest names, email addresses, tickets, RSVP status, and so on. This makes it easier to build custom functionality around event management, such as sending custom notifications to guests, managing event capacity, and generating reports on attendance.\n\nThe Event Guests API allows you to: \n\n* Retrieve a list of guests by event ID.\n* Get information about each individual ticket buyer.\n* Find out the attendance status of each guest.\n\n## Terminology\n\n- **Guest**: The individual who has been invited to the event.\n- **RSVP**: A response from the guest indicating whether they plan to attend the event.\n- **Ticket buyer**: The individual who bought 1 or more tickets to the event.\n- **Check-in**: The process of verifying a guest's attendance at the event.\n- **Guest list**: A summary of all guests who have been invited to the event.\n- **Organizer**: The person or entity responsible for planning and hosting the event.","displayName":"Introduction","slugifyName":"introduction"},{"content":"To use the Guests API, install the `@wix/events` package using npm or Yarn:\n ```console\nnpm install @wix/events\n```\n\nor\n\n```console\nyarn add @wix/events\n```\n\nThen import `{ guests }` from `@wix/events`:\n\n```js\nimport { guests } from '@wix/events'\n```\n ","displayName":"Setup","slugifyName":"setup"}],"builderTypes":[{"kind":"REFERENCE","name":"GuestsQueryBuilder","referenceFqn":"GuestsQueryBuilder"},{"kind":"REFERENCE","name":"GuestsQueryResult","referenceFqn":"GuestsQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}