{"id":"6059c37c-9d25-45cd-9fe4-ff422e553517","createdDate":"2024-09-16T13:39:14.536Z","updatedDate":"2024-09-16T13:39:14.536Z","resourceId":"2e7c8d35-fc9a-497d-a3a6-b0ed6d1f7a9a","sdk":{"schema":{"name":"events_policies","fqn":"","slug":"events-policies","typesMap":{"Policy":{"name":"Policy","fqn":"Policy","slug":"policy","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the policy was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the policy's latest update in."},{"name":"body","slug":"body","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy body, usually containing various terms and conditions.\n\nMin: 1 character\n\nMax: 50000 characters.\n\n**Note**: You can format text using various HTML tags such as `

`, ``, `

`, etc."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the event to which the policy belongs."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy name that is visible in the dashboard and checkout form.\n\nMin: 1 character\n\nMax: 40 characters"},{"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 policy is updated. The existing revision must be used when updating a policy to prevent conflicting changes. You'll get an error if you try to use the previous revision."}]},"PoliciesQueryBuilder":{"name":"PoliciesQueryBuilder","fqn":"PoliciesQueryBuilder","slug":"policies-query-builder","actions":[{"name":"ascending","fqn":"PoliciesQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = policies.queryPolicies.ascending('_id');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().ascending('_id').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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = policies.queryPolicies.descending('_id');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().descending('_id').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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = policies.queryPolicies.eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = policies.queryPolicies.exists('description', 'some-description');\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PoliciesQueryResult","referenceFqn":"PoliciesQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = policies.queryPolicies.find();\n"},{"title":"Perform a `find` on a query","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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":"PoliciesQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = policies.queryPolicies.ge('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = policies.queryPolicies.gt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = policies.queryPolicies.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = policies.queryPolicies.le('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = policies.queryPolicies.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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 = policies.queryPolicies.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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":"PoliciesQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = policies.queryPolicies.lt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = policies.queryPolicies.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies\n .queryPolicies()\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 `PoliciesQueryBuilder` 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":"PoliciesQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().find();\n\n const nextCursor = results.cursors.next;\n return policies.queryPolicies().skipTo(nextCursor).find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().find();\n\n const prevCursor = results.cursors.prev;\n return policies.queryPolicies().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 `PoliciesQueryBuilder` 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":[]},"PoliciesQueryResult":{"name":"PoliciesQueryResult","fqn":"PoliciesQueryResult","slug":"policies-query-result","actions":[{"name":"hasNext","fqn":"PoliciesQueryResult.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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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 `policies` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"PoliciesQueryResult.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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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 `policies` to navigate the pages of a query result."},{"name":"next","fqn":"PoliciesQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PoliciesQueryResult","referenceFqn":"PoliciesQueryResult"}},"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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await policies.queryPolicies().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()`](/policies/policies-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 `policies` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `PoliciesQueryBuilder` may change."},{"name":"prev","fqn":"PoliciesQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PoliciesQueryResult","referenceFqn":"PoliciesQueryResult"}},"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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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()`](/policies/policies-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 `policies` 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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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":"Policy","referenceFqn":"Policy"}},"description":"Returns an array of `policies` 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()`](/policies/policies-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 `policies` 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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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()`](/policies/policies-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 `policies` 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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().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()`](/policies/policies-query-builder/limit) in `PoliciesQueryBuilder`."},{"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 { policies } from '@wix/events';\n\nexport async function myQueryFunction() {\n const results = await policies.queryPolicies().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"description":"Returns the `PoliciesQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `PoliciesQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `PoliciesQueryBuilder`."}]},"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 pointing to 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 previous page in the list of results."}]},"ReorderEventPoliciesOptions":{"name":"ReorderEventPoliciesOptions","fqn":"ReorderEventPoliciesOptions","slug":"reorder-event-policies-options","actions":[],"oneofProperties":{"reorderEventPoliciesRequestReferencePolicy":[{"name":"afterPolicyId","slug":"after-policy-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Move the given `policyId` after the specified policy."},{"name":"beforePolicyId","slug":"before-policy-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"properties":[]},"ReorderEventPoliciesResponse":{"name":"ReorderEventPoliciesResponse","fqn":"ReorderEventPoliciesResponse","slug":"reorder-event-policies-response","actions":[],"properties":[{"name":"policies","slug":"policies","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"}},"description":"Ordered event policies."}]},"UpdatePolicy":{"name":"UpdatePolicy","fqn":"UpdatePolicy","slug":"update-policy","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date policy was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the policy's latest update in `yyyy-mm-ddThh:mm:sssZ` format."},{"name":"body","slug":"body","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy body. Here you can enter various terms and conditions.\n\nMin: 1 character\n\nMax: 50000 characters\n\n**Note**: You can format text using various HTML tags such as `
`, ``, `
`, etc."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the event to which the policy belongs."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy name that is visible in the dashboard and checkout form.\n\nMin: 1 character\n\nMax: 40 characters"},{"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 policy is updated. The existing revision must be used when updating a policy to prevent conflicting changes. You'll get an error if you try to use the previous revision."}]},"OnPolicyCreatedHandler":{"name":"OnPolicyCreatedHandler","fqn":"OnPolicyCreatedHandler","slug":"on-policy-created-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PolicyCreatedEnvelope","referenceFqn":"PolicyCreatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"PolicyCreatedEnvelope":{"name":"PolicyCreatedEnvelope","fqn":"PolicyCreatedEnvelope","slug":"policy-created-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"}},{"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":[]},"OnPolicyDeletedHandler":{"name":"OnPolicyDeletedHandler","fqn":"OnPolicyDeletedHandler","slug":"on-policy-deleted-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PolicyDeletedEnvelope","referenceFqn":"PolicyDeletedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"PolicyDeletedEnvelope":{"name":"PolicyDeletedEnvelope","fqn":"PolicyDeletedEnvelope","slug":"policy-deleted-envelope","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"OnPolicyUpdatedHandler":{"name":"OnPolicyUpdatedHandler","fqn":"OnPolicyUpdatedHandler","slug":"on-policy-updated-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PolicyUpdatedEnvelope","referenceFqn":"PolicyUpdatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"PolicyUpdatedEnvelope":{"name":"PolicyUpdatedEnvelope","fqn":"PolicyUpdatedEnvelope","slug":"policy-updated-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.events.v2.policy"},"actions":[{"name":"createPolicy","fqn":"createPolicy","slug":"create-policy","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["policy","policy.body","policy.eventId","policy.name"],"permissionIds":["WIX_EVENTS.MANAGE_POLICIES"],"permissions":["Manage Events - all permissions","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"},"description":"Created policy."},"examples":[{"title":"createPolicy: Wix-hosted","content":"import { policies } from '@wix/events';\n\nasync function createPolicy(policy) {\n const response = await policies.createPolicy(policy);\n};"},{"title":"createPolicy: 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 { policies } 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: { policies },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function createPolicy(policy) {\n const response = await myWixClient.policies.createPolicy(policy);\n};"}],"actionParams":[{"name":"policy","slug":"policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"},"description":"Policy info."}],"description":"Creates a policy.\n\n\n\n\nThe `createPolicy()` function returns a Promise that resolves to the newly-created policy.\n\nYou can create up to 3 policies per event. If you try to create more than 3, you'll get the \"Maximum number of policies for the event has been reached\" error.","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"isAdminMethod":true},{"name":"deletePolicy","fqn":"deletePolicy","slug":"delete-policy","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["policyId"],"permissionIds":["WIX_EVENTS.MANAGE_POLICIES"],"permissions":["Manage Events - all permissions","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"deletePolicy: Wix-hosted","content":"import { policies } from '@wix/events';\n\nasync function deletePolicy(policyId) {\n const response = await policies.deletePolicy(policyId);\n};"},{"title":"deletePolicy: 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 { policies } 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: { policies },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deletePolicy(policyId) {\n const response = await myWixClient.policies.deletePolicy(policyId);\n};"}],"actionParams":[{"name":"policyId","slug":"policy-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the policy to delete."}],"description":"Permanently deletes a policy.\n\n\n\n\nThe `deletePolicy()` function returns a Promise that resolves when the specified policy is deleted.\n\nDeleted policies are not returned by the `getPolicy()` or `queryPolicies()` functions.","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"isAdminMethod":true},{"name":"getPolicy","fqn":"getPolicy","slug":"get-policy","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["policyId"],"permissionIds":["WIX_EVENTS.READ_POLICIES"],"permissions":["Manage Events - all permissions","Read Policies","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.READ-POLICIES","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"},"description":"The requested policy."},"examples":[{"title":"getPolicy: Wix-hosted","content":"import { policies } from '@wix/events';\n\nasync function getPolicy(policyId) {\n const response = await policies.getPolicy(policyId);\n};"},{"title":"getPolicy: 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 { policies } 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: { policies },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getPolicy(policyId) {\n const response = await myWixClient.policies.getPolicy(policyId);\n};"}],"actionParams":[{"name":"policyId","slug":"policy-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy ID."}],"description":"Retrieves a policy by ID.\n\n\nThe `getPolicy()` function returns a Promise that resolves to a policy whose ID matches the given ID.","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"},{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}],"isAdminMethod":false},{"name":"queryPolicies","fqn":"queryPolicies","slug":"query-policies","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["WIX_EVENTS.READ_POLICIES"],"permissions":["Manage Events - all permissions","Read Policies","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.READ-POLICIES","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},"examples":[{"title":"queryPolicies: Wix-hosted","content":"import { policies } from '@wix/events';\n\nasync function queryPolicies() {\n const { items } = await policies.queryPolicies().find();\n};"},{"title":"queryPolicies: 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 { policies } 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: { policies },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryPolicies() {\n const { items } = await myWixClient.policies.queryPolicies().find();\n};"}],"description":"Creates a query to retrieve a list of policies, given the provided paging and filter. \n\n\nThe `queryPolicies()` function builds a query to retrieve a list of policies and returns a [PoliciesQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder) object.\n\nThe returned object contains the query definition which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/find) function.\n\nYou can refine the query by chaining `PoliciesQueryBuilder` functions onto the query. `PoliciesQueryBuilder` functions enable you to sort, filter and control the results that `PoliciesQueryBuilder.find()` returns.\n\nThe query runs with the following `PoliciesQueryBuilder` defaults that you can override:\n\n[`limit`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/limit): `50` \n[`descending`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/descending): `_createdDate`\n\nThe functions that are chained to `queryPolicies()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the id property in descending order, the results are sorted by the created date and then, if there are multiple results with the same date, the items are sorted by the id.\n\nThe table below shows which `PoliciesQueryBuilder` functions are supported for `queryPoliciesGuests()`. You can only use one filter function for each property. If a property is used in more than one filter, only the first filter will work.\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|\n|`revision`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`lt()`](/policies/policies-query-builder/lt),[`le()`](/policies/policies-query-builder/le),[`gt()`](/policies/policies-query-builder/gt),[`ge()`](/policies/policies-query-builder/ge),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|\n|`_createdDate`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`lt()`](/policies/policies-query-builder/lt),[`le()`](/policies/policies-query-builder/le),[`gt()`](/policies/policies-query-builder/gt),[`ge()`](/policies/policies-query-builder/ge),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`lt()`](/policies/policies-query-builder/lt),[`le()`](/policies/policies-query-builder/le),[`gt()`](/policies/policies-query-builder/gt),[`ge()`](/policies/policies-query-builder/ge),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|\n|`name`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|\n|`body`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|\n|`eventId`|[`eq()`](/policies/policies-query-builder/eq),[`ne()`](/policies/policies-query-builder/ne),[`in()`](/policies/policies-query-builder/in),[`exists()`](/policies/policies-query-builder/exists),[`ascending()`](/policies/policies-query-builder/ascending),[`descending()`](/policies/policies-query-builder/descending)|","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"},{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}],"isAdminMethod":false},{"name":"reorderEventPolicies","fqn":"reorderEventPolicies","slug":"reorder-event-policies","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["eventId","policyId"],"permissionIds":["WIX_EVENTS.MANAGE_POLICIES"],"permissions":["Manage Events - all permissions","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ReorderEventPoliciesResponse","referenceFqn":"ReorderEventPoliciesResponse"}},"examples":[{"title":"reorderEventPolicies: Wix-hosted","content":"import { policies } from '@wix/events';\n\nasync function reorderEventPolicies(policyId, eventId, options) {\n const response = await policies.reorderEventPolicies(policyId, eventId, options);\n};"},{"title":"reorderEventPolicies: 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 { policies } 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: { policies },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function reorderEventPolicies(policyId, eventId, options) {\n const response = await myWixClient.policies.reorderEventPolicies(policyId, eventId, options);\n};"}],"actionParams":[{"name":"policyId","slug":"policy-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event policy ID."},{"name":"eventId","slug":"event-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReorderEventPoliciesOptions","referenceFqn":"ReorderEventPoliciesOptions"},"description":"Options for Reorder Event Policies function."}],"description":"Changes policy order in an event dashboard and agreement checkbox on the checkout form.\nFor example, if we have 3 policies in the list, after using this function the 3rd policy will become the 1st, and other policies will move by 1 position. By default, the policies are arranged by the created date in descending order.\n\n> **Note**: it is possible to use both `beforePolicyId` and `afterPolicyId` at the same time but only the last one defined will be executed.\n\n\n\nThe `reorderEventPolicies()` function returns a Promise that resolves to the newly-reordered policy.","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"isAdminMethod":true},{"name":"updatePolicy","fqn":"updatePolicy","slug":"update-policy","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","policy","policy.body","policy.eventId","policy.name","policy.revision"],"permissionIds":["WIX_EVENTS.MANAGE_POLICIES"],"permissions":["Manage Events - all permissions","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Policy","referenceFqn":"Policy"},"description":"The updated policy."},"examples":[{"title":"updatePolicy: Wix-hosted","content":"import { policies } from '@wix/events';\n\nasync function updatePolicy(id, policy, options) {\n const response = await policies.updatePolicy(id, policy, options);\n};"},{"title":"updatePolicy: 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 { policies } 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: { policies },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updatePolicy(id, policy, options) {\n const response = await myWixClient.policies.updatePolicy(id, policy, options);\n};"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy ID."},{"name":"policy","slug":"policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdatePolicy","referenceFqn":"UpdatePolicy"},"description":"Policy to update."}],"description":"Updates a policy.\n\n\n\nThe `updatePolicy()` function returns a Promise that resolves to the newly-updated policy.\n\nEach time the policy is updated, `revision` increments by 1. The existing `revision` must be included when updating the policy. This ensures you're working with the latest policy and prevents unintended overwrites.","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"isAdminMethod":true}],"webhooks":[{"name":"onPolicyCreated","fqn":"onPolicyCreated","slug":"on-policy-created","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnPolicyCreatedHandler","referenceFqn":"OnPolicyCreatedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a policy is created.","examples":[{"title":"onPolicyCreated: Wix-hosted","content":"import { policies } from '@wix/events';\n\npolicies.onPolicyCreated((event) => {\n // handle your event here\n});"},{"title":"onPolicyCreated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { policies } 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 policies,\n },\n});\n\nwixClient.policies.onPolicyCreated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_EVENTS.READ_POLICIES"],"permissions":["Manage Events - all permissions","Read Policies","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.READ-POLICIES","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"eventType":"wix.events.v2.policy_created","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"},{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}]},{"name":"onPolicyDeleted","fqn":"onPolicyDeleted","slug":"on-policy-deleted","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnPolicyDeletedHandler","referenceFqn":"OnPolicyDeletedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a policy is deleted.","examples":[{"title":"onPolicyDeleted: Wix-hosted","content":"import { policies } from '@wix/events';\n\npolicies.onPolicyDeleted((event) => {\n // handle your event here\n});"},{"title":"onPolicyDeleted: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { policies } 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 policies,\n },\n});\n\nwixClient.policies.onPolicyDeleted((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_EVENTS.READ_POLICIES"],"permissions":["Manage Events - all permissions","Read Policies","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.READ-POLICIES","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"eventType":"wix.events.v2.policy_deleted","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"},{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}]},{"name":"onPolicyUpdated","fqn":"onPolicyUpdated","slug":"on-policy-updated","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnPolicyUpdatedHandler","referenceFqn":"OnPolicyUpdatedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a policy is updated.","examples":[{"title":"onPolicyUpdated: Wix-hosted","content":"import { policies } from '@wix/events';\n\npolicies.onPolicyUpdated((event) => {\n // handle your event here\n});"},{"title":"onPolicyUpdated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { policies } 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 policies,\n },\n});\n\nwixClient.policies.onPolicyUpdated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_EVENTS.READ_POLICIES"],"permissions":["Manage Events - all permissions","Read Policies","Manage Policies"],"permissionsScopesIds":["SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS","SCOPE.DC-EVENTS.READ-POLICIES","SCOPE.DC-EVENTS.MANAGE-POLICIES"],"eventType":"wix.events.v2.policy_updated","permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"},{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}]}],"articles":[{"content":"# Introduction\n\nWith Events Policies APIs, you can manage the policies for a particular event. For example, you can create, update, and delete policies. You can also reorder policies in the Event Dashboard and checkout form.\n\nPolicies define terms & conditions for the events, such as terms for canceling attendance, transferring a ticket to another person, and so on. For example: \"Participants are entitled to a 100% refund if canceling attendance 1 week prior to the event. After this date, participants will be refunded 50% of the ticket price.\"\n\nA policy agreement checkbox will be added to the RSVP or checkout form. The policy text can be read in a pop-up window if you click the policy name. By default, there are no policies when you first create an event.\n\n## Terminology\n\n- **Policy**: text that defines terms & conditions, as relevant.\n- **Event Dashboard**: controls center which allows users to manage their site events settings and features.\n- **Checkout form**: the final step in the ticket purchasing process where the customer fills in personal info, reads policies and pays money.\n","displayName":"Introduction","slugifyName":"introduction"},{"content":"To use the Policies 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 `{ policies }` from `@wix/events`:\n\n```js\nimport { policies } from '@wix/events'\n```\n ","displayName":"Setup","slugifyName":"setup"}],"builderTypes":[{"kind":"REFERENCE","name":"PoliciesQueryBuilder","referenceFqn":"PoliciesQueryBuilder"},{"kind":"REFERENCE","name":"PoliciesQueryResult","referenceFqn":"PoliciesQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}

onPolicyCreated( )