{"id":"57e1e388-4912-44f7-bce4-b96c7de90141","createdDate":"2023-07-30T12:43:48.442Z","updatedDate":"2023-07-30T12:43:48.442Z","resourceId":"5171c11c-d3f5-4d56-bf05-53a33b148871","api":{"schema":{"object":{"displayName":"Policy Object","description":"","slug":"policy-object","$ref":"#/components/schemas/wix.events.v2.Policy","legacyExamples":[{"title":"Policy","content":"{\n \"policy\": \n {\n \"id\": \"eef70fb3-8567-4861-9f77-ebd2ad3682d5\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T11:54:51.037Z\",\n \"updatedDate\": \"2023-02-14T11:54:51.037Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"

Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.

\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/events.git"},"methods":[{"summary":"Create Policy","description":"Creates a policy.\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.","operationId":"wix.events.v2.PolicyManagement.CreatePolicy","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.v2.CreatePolicyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-policies","destinationPath":"","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/events/v2/policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events/v2/policies","destinationPath":"/v2/policies","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreatePolicyRequest","description":"","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"Policy info.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["policy","policy.name","policy.body","policy.eventId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Policy Created","description":"Triggered when a policy is created.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"POLICIES_LIMIT_REACHED"}],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.CreatePolicyRequest","responseMessage":"wix.events.v2.CreatePolicyResponse"},"legacyExamples":[{"name":"CreatePolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Create Policy","request":"curl -X POST 'https://www.wixapis.com/events-policies/v2/policies' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"policy\": {\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}'","response":"{\n \"policy\": \n {\n \"id\": \"eef70fb3-8567-4861-9f77-ebd2ad3682d5\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T11:54:51.037Z\",\n \"updatedDate\": \"2023-02-14T11:54:51.037Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v2/policies","rpcOnly":false,"triggeredEvents":[{"title":"Policy Created","description":"Triggered when a policy is created.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"POLICIES_LIMIT_REACHED"}],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.CreatePolicyRequest","responseMessage":"wix.events.v2.CreatePolicyResponse"},"legacyExamples":[{"name":"CreatePolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Create Policy","request":"curl -X POST 'https://www.wixapis.com/events-policies/v2/policies' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"policy\": {\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}'","response":"{\n \"policy\": \n {\n \"id\": \"eef70fb3-8567-4861-9f77-ebd2ad3682d5\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T11:54:51.037Z\",\n \"updatedDate\": \"2023-02-14T11:54:51.037Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Create Policy","slugifiedName":"create-policy"}},{"summary":"Update Policy","description":"Updates a policy.\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.","operationId":"wix.events.v2.PolicyManagement.UpdatePolicy","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"policy.id","description":"Policy ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.events.v2.UpdatePolicyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-policies","destinationPath":"","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/events/v2/policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events/v2/policies","destinationPath":"/v2/policies","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdatePolicyRequest","description":"","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"Policy to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["policy","policy.name","policy.id","policy.body","policy.eventId","policy.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Policy Updated","description":"Triggered when a policy is updated.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.UpdatePolicyRequest","responseMessage":"wix.events.v2.UpdatePolicyResponse"},"legacyExamples":[{"name":"UpdatePolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Update Policy","request":"curl -X PATCH 'https://manage.wix.com/_api/events-policies/v2/policies/7243931d-74e4-4d6a-91f0-4835fa79161e' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"policy\": {\n \"name\": \"Terms and Conditions Event 4\",\n \"body\": \"If the Event is rescheduled, changed, moved or cancelled the Organiser cannot be held responsible for any resulting costs you may incur for travel, accommodation and other related goods, services or compensation.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\"\n }\n}'","response":"{\n \"policy\": {\n \"id\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-02-14T11:54:08.379Z\",\n \"updatedDate\": \"2023-02-14T13:22:13.564Z\",\n \"name\": \"Terms and Conditions Event 4\",\n \"body\": \"If the Event is rescheduled, changed, moved or cancelled the Organiser cannot be held responsible for any resulting costs you may incur for travel, accommodation and other related goods, services or compensation.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"patch","path":"/v2/policies/{policy.id}","rpcOnly":false,"triggeredEvents":[{"title":"Policy Updated","description":"Triggered when a policy is updated.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.UpdatePolicyRequest","responseMessage":"wix.events.v2.UpdatePolicyResponse"},"legacyExamples":[{"name":"UpdatePolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Update Policy","request":"curl -X PATCH 'https://manage.wix.com/_api/events-policies/v2/policies/7243931d-74e4-4d6a-91f0-4835fa79161e' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"policy\": {\n \"name\": \"Terms and Conditions Event 4\",\n \"body\": \"If the Event is rescheduled, changed, moved or cancelled the Organiser cannot be held responsible for any resulting costs you may incur for travel, accommodation and other related goods, services or compensation.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\"\n }\n}'","response":"{\n \"policy\": {\n \"id\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-02-14T11:54:08.379Z\",\n \"updatedDate\": \"2023-02-14T13:22:13.564Z\",\n \"name\": \"Terms and Conditions Event 4\",\n \"body\": \"If the Event is rescheduled, changed, moved or cancelled the Organiser cannot be held responsible for any resulting costs you may incur for travel, accommodation and other related goods, services or compensation.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Update Policy","slugifiedName":"update-policy"}},{"summary":"Get Policy","description":"Retrieves a policy.","operationId":"wix.events.v2.PolicyManagement.GetPolicy","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"policyId","description":"Policy ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.events.v2.GetPolicyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-policies","destinationPath":"","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/events/v2/policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events/v2/policies","destinationPath":"/v2/policies","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.READ_POLICIES"],"externalPermissionScopes":[{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.GetPolicyRequest","responseMessage":"wix.events.v2.GetPolicyResponse"},"legacyExamples":[{"name":"GetPolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Get Policy","request":"curl -X GET 'https://www.wixapis.com/events-policies/v2/policies?7243931d-74e4-4d6a-91f0-4835fa79161e' \\\n-H 'Authorization: '","response":"{\n \"policy\": {\n \"id\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T11:54:08.379Z\",\n \"updatedDate\": \"2023-02-14T11:54:08.379Z\",\n \"name\": \"Terms and Conditions Event 2\",\n \"body\": \"Nobody will be allowed admission to the Event without a valid ticket or pass.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"get","path":"/v2/policies/{policyId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.READ_POLICIES"],"externalPermissionScopes":[{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.GetPolicyRequest","responseMessage":"wix.events.v2.GetPolicyResponse"},"legacyExamples":[{"name":"GetPolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Get Policy","request":"curl -X GET 'https://www.wixapis.com/events-policies/v2/policies?7243931d-74e4-4d6a-91f0-4835fa79161e' \\\n-H 'Authorization: '","response":"{\n \"policy\": {\n \"id\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T11:54:08.379Z\",\n \"updatedDate\": \"2023-02-14T11:54:08.379Z\",\n \"name\": \"Terms and Conditions Event 2\",\n \"body\": \"Nobody will be allowed admission to the Event without a valid ticket or pass.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Get Policy","slugifiedName":"get-policy"}},{"summary":"Delete Policy","description":"Permanently deletes a policy.","operationId":"wix.events.v2.PolicyManagement.DeletePolicy","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"policyId","description":"ID of the policy to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.events.v2.DeletePolicyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-policies","destinationPath":"","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/events/v2/policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events/v2/policies","destinationPath":"/v2/policies","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Policy Deleted","description":"Triggered when a policy is deleted.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.DeletePolicyRequest","responseMessage":"wix.events.v2.DeletePolicyResponse"},"legacyExamples":[{"name":"DeletePolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Delete Policy","request":"curl -X DELETE 'https://www.wixapis.com/events-policies/v2/policies/7243931d-74e4-4d6a-91f0-4835fa79161e' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"delete","path":"/v2/policies/{policyId}","rpcOnly":false,"triggeredEvents":[{"title":"Policy Deleted","description":"Triggered when a policy is deleted.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.DeletePolicyRequest","responseMessage":"wix.events.v2.DeletePolicyResponse"},"legacyExamples":[{"name":"DeletePolicy","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Delete Policy","request":"curl -X DELETE 'https://www.wixapis.com/events-policies/v2/policies/7243931d-74e4-4d6a-91f0-4835fa79161e' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Delete Policy","slugifiedName":"delete-policy"}},{"summary":"Query Policies","description":"Retrieves a list of policies according to the provided filters and paging.","operationId":"wix.events.v2.PolicyManagement.QueryPolicies","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.v2.QueryPoliciesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-policies","destinationPath":"","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/events/v2/policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events/v2/policies","destinationPath":"/v2/policies","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryPoliciesRequest","description":"","properties":{"query":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.QueryV2","summary":"query","description":"Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.v2.PolicyManagement","errors":[],"exposure":"PUBLIC","permissions":["WIX_EVENTS.READ_POLICIES"],"externalPermissionScopes":[{"name":"Read Policies","scopeId":"SCOPE.DC-EVENTS.READ-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.QueryPoliciesRequest","responseMessage":"wix.events.v2.QueryPoliciesResponse"},"legacyExamples":[{"name":"QueryPolicies","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Query policies by event ID and sort by created date in descending order","request":"curl -X POST 'https://www.wixapis.com/events-policies/v2/policies/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"query\": {\n \"filter\": {\n \"eventId\": {\n \"$eq\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ]\n }\n}'","response":"{\n \"policies\": [\n {\n \"id\": \"eef70fb3-8567-4861-9f77-ebd2ad3682d5\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T12:31:52.850Z\",\n \"updatedDate\": \"2023-02-14T12:31:52.850Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"

Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.

\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n },\n {\n \"id\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T11:54:08.379Z\",\n \"updatedDate\": \"2023-02-14T11:54:08.379Z\",\n \"name\": \"Terms and Conditions Event 2\",\n \"body\": \"Nobody will be allowed admission to the Event without a valid ticket or pass.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"cursors\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Query Policies","slugifiedName":"query-policies"}},{"summary":"Reorder Event Policies","description":"Changes policy order in an event dashboard and agreement checkbox on the checkout form. By default, the policies are arranged by the created date in descending order.\n> **Note:** It is possible to use both `beforePolicyId` and `afterPolicyId` at the same time but only the last one defined will be executed.","operationId":"wix.events.v2.PolicyManagement.ReorderEventPolicies","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.v2.ReorderEventPoliciesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-policies","destinationPath":"","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/events/v2/policies","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events/v2/policies","destinationPath":"/v2/policies","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ReorderEventPoliciesRequest","description":"","properties":{"eventId":{"title":"eventId","description":"Event ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"policyId":{"title":"policyId","description":"Policy ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"oneOf":[{"description":"","summary":"referencePolicy","$ref":"#/components/schemas/wix.events.v2.ReorderEventPoliciesRequest.referencePolicy"}],"required":["policyId","eventId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Policy Updated","description":"Triggered when a policy is updated.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_REORDER_INSTRUCTION"}],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.ReorderEventPoliciesRequest","responseMessage":"wix.events.v2.ReorderEventPoliciesResponse"},"legacyExamples":[{"name":"ReorderEventPolicies","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Reorder Policies","request":"curl -X POST 'https://www.wixapis.com/events-policies/v2/policies/reorder' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"policyId\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"beforePolicyId\": \"0edc5dc9-3c0b-4b80-80c7-452d4009bf89\"\n}'","response":"{\n \"policies\": [\n {\n \"id\": \"eef70fb3-8567-4861-9f77-ebd2ad3682d5\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-02-14T12:31:52.850Z\",\n \"updatedDate\": \"2023-02-14T13:29:17.308Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"

Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.

\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n },\n {\n \"id\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"revision\": \"3\",\n \"createdDate\": \"2023-02-14T11:54:08.379Z\",\n \"updatedDate\": \"2023-02-14T13:29:17.308Z\",\n \"name\": \"Terms and Conditions Event 2\",\n \"body\": \"Nobody will be allowed admission to the Event without a valid ticket or pass.\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n },\n {\n \"id\": \"0edc5dc9-3c0b-4b80-80c7-452d4009bf89\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-14T12:54:28.557Z\",\n \"updatedDate\": \"2023-02-14T12:54:28.557Z\",\n \"name\": \"Terms and Conditions Event 3\",\n \"body\": \"

All tickets or passes should be checked on purchase, as mistakes cannot always be rectified.

\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v2/policies/reorder","rpcOnly":false,"triggeredEvents":[{"title":"Policy Updated","description":"Triggered when a policy is updated.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/events.git"}],"serviceName":"wix.events.v2.PolicyManagement","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_REORDER_INSTRUCTION"}],"exposure":"PUBLIC","permissions":["WIX_EVENTS.MANAGE_POLICIES"],"externalPermissionScopes":[{"name":"Manage Policies","scopeId":"SCOPE.DC-EVENTS.MANAGE-POLICIES"}],"protoArtifactId":"com.wixpress.events:events-policies","serviceArtifactId":"com.wixpress.events.events-policies","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.v2.ReorderEventPoliciesRequest","responseMessage":"wix.events.v2.ReorderEventPoliciesResponse"},"legacyExamples":[{"name":"ReorderEventPolicies","serviceName":"PolicyManagement","type":"METHOD","content":{"title":"Reorder Policies","request":"curl -X POST 'https://www.wixapis.com/events-policies/v2/policies/reorder' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"policyId\": \"7243931d-74e4-4d6a-91f0-4835fa79161e\",\n \"beforePolicyId\": \"0edc5dc9-3c0b-4b80-80c7-452d4009bf89\"\n}'","response":"{\n \"policies\": [\n {\n \"id\": \"eef70fb3-8567-4861-9f77-ebd2ad3682d5\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-02-14T12:31:52.850Z\",\n \"updatedDate\": \"2023-02-14T13:29:17.308Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"

Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.

All tickets or passes should be checked on purchase, as mistakes cannot always be rectified.

\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Reorder Event Policies","slugifiedName":"reorder-event-policies"}}],"webhooks":[{"summary":"Policy Created","title":"Policy Created","description":"Triggered when a policy is created.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"CREATED","legacyExamples":[{"name":"PolicyCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"d2ac890c-217d-4613-9216-232759230bc8\",\n \"entityFqdn\": \"wix.events.v2.policy\",\n \"slug\": \"created\",\n \"entityId\": \"6329e76a-773d-4319-bdce-1d522890e319\",\n \"createdEvent\": \n {\n \"entityAsJson\": \n {\n \"id\": \"6329e76a-773d-4319-bdce-1d522890e319\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-02-23T11:28:21.954Z\",\n \"updatedDate\": \"2023-02-23T11:28:21.954Z\",\n \"name\": \"Terms and Conditions Event 1\",\n \"body\": \"

Tickets to this Event are issued on behalf of the Organiser and are subject to the following terms and conditions.

\",\n \"eventId\": \"3d3d5c04-ece0-45a8-85f0-11a58edaa192\"\n }\n },\n \"eventTime\": \"2023-02-23T11:28:21.958239Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}"}],"sourceRepo":"git@github.com:wix-private/events.git","$ref":"#/components/schemas/wix.events.v2.Policy","contentLink":{"displayName":"Policy Created","slugifiedName":"policy-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Policy Updated","title":"Policy Updated","description":"Triggered when a policy is updated.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"UPDATED","legacyExamples":[{"name":"PolicyUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\":\"35bac96d-0d27-4a69-a905-2c7dfa161e28\",\n \"entityFqdn\":\"wix.events.v2.policy\",\n \"slug\":\"updated\",\n \"entityId\":\"e9bf5e65-b38d-4732-ac7f-268f94d95975\",\n \"updatedEvent\":{\n \"currentEntityAsJson\": \n {\n \"id\":\"e9bf5e65-b38d-4732-ac7f-268f94d95975\",\n \"revision\":\"2\",\n \"createdDate\":\"2023-02-23T11:44:16.564Z\",\n \"updatedDate\":\"2023-02-23T11:49:44.568Z\",\n \"name\":\"Terms and Conditions Event 4\",\n \"body\":\"If the Event is rescheduled, changed, moved or cancelled the Organiser cannot be held responsible for any resulting costs you may incur for travel, accommodation and other related goods, services or compensation.\",\n \"eventId\":\"1145ae58-f1e4-4e11-aa7a-9292f0e356e8\"}\n },\n \"eventTime\":\"2023-02-23T11:49:44.576305Z\",\n \"triggeredByAnonymizeRequest\":false,\n \"entityEventSequence\":\"2\"\n}"}],"sourceRepo":"git@github.com:wix-private/events.git","$ref":"#/components/schemas/wix.events.v2.Policy","contentLink":{"displayName":"Policy Updated","slugifiedName":"policy-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Policy Deleted","title":"Policy Deleted","description":"Triggered when a policy is deleted.","permissions":["WIX_EVENTS.READ_POLICIES"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.events.v2.policy","serviceName":"wix.events.v2.PolicyManagement","domainEvent":"DELETED","legacyExamples":[{"name":"PolicyDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"3600c836-1e2a-4f91-bdd6-a6302316805a\",\n \"entityFqdn\": \"wix.events.v2.policy\",\n \"slug\": \"deleted\",\n \"entityId\": \"e9bf5e65-b38d-4732-ac7f-268f94d95975\",\n \"deletedEvent\": \n {\n \"movedToTrash\": true\n },\n \"eventTime\": \"2023-02-23T11:51:00.542009Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/events.git","$ref":"#/components/schemas/wix.events.v2.Policy","contentLink":{"displayName":"Policy Deleted","slugifiedName":"policy-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Policies v2\n\nWith 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## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n- Install the **Wix Events & Tickets** app from [Wix App Market](https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events).\n- You can create up to 3 policies per event.\n\n## Use cases\n\n- [Sync event policies with external ticketing system](https://dev.wix.com/api/rest/wix-events/policies-v2/sample-use-cases-&-flows#wix-events_policies-v2_sample-use-cases-&-flows_sync-event-policies-with-external-ticketing-system)\n\n## Terminology\n\n- **Policy**: text that defines terms & conditions, as relevant.\n- **Event Dashboard**: control center, which allows you 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.","sourceRepo":"git@github.com:wix-private/events.git","path":"proto/docs/intro.md"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Policies v2: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Policy object:\n\n| Field | Query Filter Operators | Sortable |\n|--------------------|-----------------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `eventId` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `name` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `body` | `$eq`, `$ne`, `$lt`, `$lte,` `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `revision` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable | \n| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n\n__Related content:__\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Policy Query endpoint](https://dev.wix.com/api/rest/wix-events/policy-v2/query-policies)","sourceRepo":"git@github.com:wix-private/events.git","path":"proto/docs/filter-and-sort.md"},{"displayName":"Sample Use Cases & Flows","slugifyName":"sample-use-cases-flows","content":"# Policies v2: Sample Use Cases & Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation. \n\n## Sync event policies with external ticketing system\n\nIf you're using a Wix site to manage events and another system to handle ticketing, you can synchronize policies between them whenever a policy is updated on the site. For instance, if the refund policies on the Wix site change, and now the policies guarantee a full refund up to only 5 days before the event, this change also needs to be reflected on your ticketing system for checkout purposes.\n\nTo upload and update all event policies defined on the Wix site to your external system for the first time, follow these steps:\n\n1. Create a custom field in your system that stores the policy ID for a particular event to ensure a 1-to-1 relationship with the external ticketing system. Craft your code so that this ID won't be overwritten by future updates from your app.\n\n2. Create a mapping from the site policies fields to the system fields that will be used whenever site policies and the external system are synchronized.\n\n3. [Query Policies](https://dev.wix.com/api/rest/wix-events/policies-v2/query-policies) by `eventId` and send the relevant information to the external ticketing system.\n\n4. On an ongoing basis, listen for changes to site policies with these webhooks:\n\n - [Policy Created Webhook](https://dev.wix.com/api/rest/wix-events/policies-v2/policy-created-webhook)\n - [Policy Updated Webhook](https://dev.wix.com/api/rest/wix-events/policies-v2/policy-updated-webhook)\n - [Policy Deleted Webhook](https://dev.wix.com/api/rest/wix-events/policies-v2/policy-deleted-webhook)\n \n5. When one of the above webhooks is triggered, you'll receive the policy in the payload. You can bring those changes to the ticketing system by retrieving the relevant info from the payload, and use mapping to take action on the external system:\n\n - For updated policies retrieve the `updatedEvent.currentEntityAsJson.id`, `updatedEvent.currentEntityAsJson.body` and/or `updatedEvent.currentEntityAsJson.name` values.\n\n - For created policies retrieve the relevant info from the `createdEvent.currentEntityAsJson` object.\n\n - For deleted policies retrieve the `createdEvent.currentEntityAsJson.id` value.\n","sourceRepo":"git@github.com:wix-private/events.git","path":"proto/docs/sample-use-cases-and-flows.md"}],"components":{"schemas":{"wix.events.v2.Policy":{"type":"object","properties":{"id":{"title":"id","description":"Policy ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"revision":{"title":"revision","description":"Revision number, which increments by 1 each time the policy is updated. To prevent conflicting changes, the existing revision must be used when updating a policy. You'll get an error if you try to use the previous revision.","readOnly":true,"$ref":"#/components/schemas/google.protobuf.Int64Value","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date and time when the policy was created in `yyyy-mm-ddThh:mm:sssZ` format.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date and time of the policy's latest update in `yyyy-mm-ddThh:mm:sssZ` format.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"","minLength":1,"maxLength":40,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"body":{"title":"body","description":"","minLength":1,"maxLength":50000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventId":{"title":"eventId","description":"ID of the event to which the policy belongs.","format":"GUID","immutable":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Policy","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"wix.events.v2.CreatePolicyRequest":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"Policy info.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreatePolicyRequest","description":""},"wix.events.v2.CreatePolicyResponse":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"Created policy.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreatePolicyResponse","description":""},"wix.events.v2.UpdatePolicyRequest":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"Policy to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdatePolicyRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"wix.events.v2.UpdatePolicyResponse":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"The updated policy.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdatePolicyResponse","description":""},"wix.events.v2.UpdatePolicySortIndexRequest":{"type":"object","properties":{"policyId":{"title":"policyId","description":"Policy's ID","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"revision":{"title":"revision","description":"The revision of the Event Policy","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"sortIndex":{"title":"sortIndex","description":"the sort index of a policy to set","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdatePolicySortIndexRequest","description":""},"wix.events.v2.UpdatePolicySortIndexResponse":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"the updated Event Policy","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdatePolicySortIndexResponse","description":""},"wix.events.v2.DeletePolicyRequest":{"type":"object","properties":{"policyId":{"title":"policyId","description":"ID of the policy to delete.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeletePolicyRequest","description":""},"wix.events.v2.DeletePolicyResponse":{"type":"object","properties":{},"title":"DeletePolicyResponse","description":""},"wix.events.v2.QueryPoliciesRequest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.QueryV2","summary":"query","description":"Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryPoliciesRequest","description":""},"wix.events.v2.policy.upstream.wix.common.QueryV2":{"type":"object","properties":{"filter":{"title":"filter","description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\", \"fieldName2\":{\"$operator\":\"value2\"} }`.

**Example:**
`\"filter\" : { \"id\": \"2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5\", \"revision\": {\"$ne\":\"1\"} }`

See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information.","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sort object in the following format:
`[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`

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

See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information.","type":"array","items":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.QueryV2.pagingMethod"}]},"wix.events.v2.policy.upstream.wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.Paging","summary":"paging","description":"Pagination options.","x-wix-docs":{"exposure":"PUBLIC"}},"cursorPaging":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.CursorPaging","summary":"cursorPaging","description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.events.v2.policy.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order (ASC/DESC). Defaults to ASC","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.events.v2.policy.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load per page.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"wix.events.v2.policy.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load per page.","minimum":0,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursor":{"title":"cursor","description":"Pointer to the next or previous page in the list of results.\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPaging","description":""},"wix.events.v2.QueryPoliciesResponse":{"type":"object","properties":{"policies":{"title":"policies","description":"List of policies.","type":"array","items":{"$ref":"#/components/schemas/wix.events.v2.Policy"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.PagingMetadataV2","summary":"metadata","description":"Metadata for the paginated results.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryPoliciesResponse","description":""},"wix.events.v2.policy.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Flag that indicates the server failed to calculate the `total` field.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cursors":{"$ref":"#/components/schemas/wix.events.v2.policy.upstream.wix.common.Cursors","summary":"cursors","description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"wix.events.v2.policy.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"title":"next","description":"Cursor pointing to next page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"prev":{"title":"prev","description":"Cursor pointing to previous page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"wix.events.v2.ReorderEventPoliciesRequest":{"type":"object","properties":{"eventId":{"title":"eventId","description":"Event ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"policyId":{"title":"policyId","description":"Policy ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ReorderEventPoliciesRequest","description":"","oneOf":[{"description":"","summary":"referencePolicy","$ref":"#/components/schemas/wix.events.v2.ReorderEventPoliciesRequest.referencePolicy"}]},"wix.events.v2.ReorderEventPoliciesRequest.referencePolicy":{"type":"object","title":"referencePolicy","properties":{"beforePolicyId":{"title":"beforePolicyId","description":"Move the given `policyId` before the referenced policy.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"afterPolicyId":{"title":"afterPolicyId","description":"Move the given `policyId` after the referenced policy.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.events.v2.ReorderEventPoliciesResponse":{"type":"object","properties":{"policies":{"title":"policies","description":"Policies in the new order.","type":"array","items":{"$ref":"#/components/schemas/wix.events.v2.Policy"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ReorderEventPoliciesResponse","description":""},"wix.events.v2.GetPolicyRequest":{"type":"object","properties":{"policyId":{"title":"policyId","description":"Policy ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPolicyRequest","description":""},"wix.events.v2.GetPolicyResponse":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/wix.events.v2.Policy","summary":"policy","description":"The requested policy.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPolicyResponse","description":""},"wix.events.events.EventCopied":{"type":"object","properties":{"timestamp":{"title":"timestamp","description":"Event created timestamp in ISO UTC format.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"eventId":{"title":"eventId","description":"Event ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"location":{"$ref":"#/components/schemas/wix.events.Location","summary":"location","description":"Event location.","x-wix-docs":{"exposure":"PUBLIC"}},"scheduleConfig":{"$ref":"#/components/schemas/wix.events.ScheduleConfig","summary":"scheduleConfig","description":"Event schedule configuration.","x-wix-docs":{"exposure":"PUBLIC"}},"title":{"title":"title","description":"Event title.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"userId":{"title":"userId","description":"Event creator user ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Event status.","type":"string","$ref":"#/components/schemas/wix.events.EventStatus","x-wix-docs":{"exposure":"PUBLIC"}},"derivedFromInstanceId":{"title":"derivedFromInstanceId","description":"Instance ID. Indicates the original app instance which current event was derived from.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"derivedFromEventId":{"title":"derivedFromEventId","description":"Event ID. Indicates the original event which current event was derived from.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"ticketDefinitions":{"title":"ticketDefinitions","description":"Map of copied ticket definitions from original event.\nKey represents ticket def id in the original event.\nValue represents ticket def id in the newly created event.","type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EventCopied","description":""},"wix.events.Location":{"type":"object","properties":{"name":{"title":"name","description":"Location name.","maxLength":50,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"coordinates":{"$ref":"#/components/schemas/wix.events.MapCoordinates","summary":"coordinates","description":"Location map coordinates.","x-wix-docs":{"exposure":"PUBLIC"}},"address":{"title":"address","description":"Single line address representation.","maxLength":150,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"Location type.","type":"string","$ref":"#/components/schemas/wix.events.Location.LocationType","x-wix-docs":{"exposure":"PUBLIC"}},"fullAddress":{"$ref":"#/components/schemas/com.wix.events.upstream.wix.common.Address","summary":"fullAddress","description":"Full address derived from formatted single line `address`.\nWhen `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.\nIf provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.\n\nMigration notes:\n- `full_address.formatted_address` is equivalent to `address`.\n- `full_address.geocode` is equivalent to `coordinates`.","x-wix-docs":{"exposure":"PUBLIC"}},"tbd":{"title":"tbd","description":"Defines event location as TBD (To Be Determined).\nWhen event location is not yet defined, `name` is displayed instead of location address.\n`coordinates`, `address`, `type` and `full_address` are not required when location is TBD.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Location","description":""},"wix.events.MapCoordinates":{"type":"object","properties":{"lat":{"title":"lat","description":"Latitude.","minimum":-90,"maximum":90,"type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"lng":{"title":"lng","description":"Longitude.","minimum":-180,"maximum":180,"type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MapCoordinates","description":""},"wix.events.Location.LocationType":{"type":"string","description":"","title":"LocationType","enum":["VENUE","ONLINE"]},"com.wix.events.upstream.wix.common.Address":{"type":"object","properties":{"country":{"title":"country","description":"country code","format":"COUNTRY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"title":"subdivision","description":"subdivision (usually state or region) code according to ISO 3166-2","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"title":"city","description":"city name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"postalCode":{"title":"postalCode","description":"zip/postal code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine2":{"title":"addressLine2","description":"Free text providing more detailed address info. Usually contains Apt, Suite, Floor","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"formattedAddress":{"title":"formattedAddress","description":"A string containing the human-readable address of this location","maxLength":150,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"hint":{"title":"hint","description":"Free text for human-to-human textual orientation aid purposes","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"geocode":{"$ref":"#/components/schemas/com.wix.events.upstream.wix.common.AddressLocation","summary":"geocode","description":"coordinates of the physical address","x-wix-docs":{"exposure":"PUBLIC"}},"countryFullname":{"title":"countryFullname","description":"country full-name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivisions":{"title":"subdivisions","description":"multi-level subdivisions from top to bottom","type":"array","items":{"$ref":"#/components/schemas/com.wix.events.upstream.wix.common.Subdivision"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":"Physical address","oneOf":[{"description":"","summary":"street","$ref":"#/components/schemas/com.wix.events.upstream.wix.common.Address.street"}]},"com.wix.events.upstream.wix.common.Address.street":{"type":"object","title":"street","properties":{"streetAddress":{"$ref":"#/components/schemas/com.wix.events.upstream.wix.common.StreetAddress","summary":"streetAddress","description":"a break down of the street to number and street name","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine":{"title":"addressLine","description":"Main address line (usually street and number) as free text","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wix.events.upstream.wix.common.StreetAddress":{"type":"object","properties":{"number":{"title":"number","description":"street number","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"street name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StreetAddress","description":""},"com.wix.events.upstream.wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"title":"latitude","description":"","minimum":-90,"maximum":90,"type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"longitude":{"title":"longitude","description":"","minimum":-180,"maximum":180,"type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddressLocation","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DoubleValue","description":""},"com.wix.events.upstream.wix.common.Subdivision":{"type":"object","properties":{"code":{"title":"code","description":"subdivision short code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"subdivision full-name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Subdivision","description":""},"wix.common.Subdivision.SubdivisionType":{"type":"string","description":"","title":"SubdivisionType","enum":["UNKNOWN_SUBDIVISION_TYPE","ADMINISTRATIVE_AREA_LEVEL_1","ADMINISTRATIVE_AREA_LEVEL_2","ADMINISTRATIVE_AREA_LEVEL_3","ADMINISTRATIVE_AREA_LEVEL_4","ADMINISTRATIVE_AREA_LEVEL_5","COUNTRY"]},"wix.events.ScheduleConfig":{"type":"object","properties":{"scheduleTbd":{"title":"scheduleTbd","description":"Defines event as TBD (To Be Determined) schedule.\nWhen event time is not yet defined, TBD message is displayed instead of event start and end times.\n`startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"scheduleTbdMessage":{"title":"scheduleTbdMessage","description":"TBD message.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"title":"startDate","description":"Event start timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"title":"endDate","description":"Event end timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"timeZoneId":{"title":"timeZoneId","description":"Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"endDateHidden":{"title":"endDateHidden","description":"Whether end date is hidden in the formatted schedule.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"showTimeZone":{"title":"showTimeZone","description":"Whether time zone is displayed in formatted schedule.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"recurrences":{"$ref":"#/components/schemas/wix.events.Recurrences","summary":"recurrences","description":"Event recurrences.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ScheduleConfig","description":""},"wix.events.Recurrences":{"type":"object","properties":{"occurrences":{"title":"occurrences","description":"Event occurrences.","maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/wix.events.Occurrence"},"x-wix-docs":{"exposure":"PUBLIC"}},"categoryId":{"title":"categoryId","description":"Recurring event category ID.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Recurrence status.","readOnly":true,"type":"string","$ref":"#/components/schemas/wix.events.RecurrenceStatus.Status","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Recurrences","description":""},"wix.events.Occurrence":{"type":"object","properties":{"startDate":{"title":"startDate","description":"Event start timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"title":"endDate","description":"Event end timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"timeZoneId":{"title":"timeZoneId","description":"Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"showTimeZone":{"title":"showTimeZone","description":"Whether time zone is displayed in formatted schedule.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Occurrence","description":""},"wix.events.RecurrenceStatus.Status":{"type":"string","description":"","title":"Status","enum":["ONE_TIME","RECURRING","RECURRING_NEXT","RECURRING_LAST_ENDED","RECURRING_LAST_CANCELED"]},"wix.events.EventStatus":{"type":"string","description":"","title":"EventStatus","enum":["SCHEDULED","STARTED","ENDED","CANCELED","DRAFT"]},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""}}},"title":"Policy","description":"","fqdn":"wix.events.v2.policy"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Policies v2\n\nWith 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## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n- Install the **Wix Events & Tickets** app from [Wix App Market](https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events).\n- You can create up to 3 policies per event.\n\n## Use cases\n\n- [Sync event policies with external ticketing system](https://dev.wix.com/api/rest/wix-events/policies-v2/sample-use-cases-&-flows#wix-events_policies-v2_sample-use-cases-&-flows_sync-event-policies-with-external-ticketing-system)\n\n## Terminology\n\n- **Policy**: text that defines terms & conditions, as relevant.\n- **Event Dashboard**: control center, which allows you 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."},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Policies v2: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Policy object:\n\n| Field | Query Filter Operators | Sortable |\n|--------------------|-----------------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `eventId` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `name` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `body` | `$eq`, `$ne`, `$lt`, `$lte,` `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `revision` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable | \n| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$hasSome`, `$exists` | Sortable |\n\n__Related content:__\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Policy Query endpoint](https://dev.wix.com/api/rest/wix-events/policy-v2/query-policies)"},{"displayName":"Sample Use Cases & Flows","slugifyName":"sample-use-cases-flows","content":"# Policies v2: Sample Use Cases & Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation. \n\n## Sync event policies with external ticketing system\n\nIf you're using a Wix site to manage events and another system to handle ticketing, you can synchronize policies between them whenever a policy is updated on the site. For instance, if the refund policies on the Wix site change, and now the policies guarantee a full refund up to only 5 days before the event, this change also needs to be reflected on your ticketing system for checkout purposes.\n\nTo upload and update all event policies defined on the Wix site to your external system for the first time, follow these steps:\n\n1. Create a custom field in your system that stores the policy ID for a particular event to ensure a 1-to-1 relationship with the external ticketing system. Craft your code so that this ID won't be overwritten by future updates from your app.\n\n2. Create a mapping from the site policies fields to the system fields that will be used whenever site policies and the external system are synchronized.\n\n3. [Query Policies](https://dev.wix.com/api/rest/wix-events/policies-v2/query-policies) by `eventId` and send the relevant information to the external ticketing system.\n\n4. On an ongoing basis, listen for changes to site policies with these webhooks:\n\n - [Policy Created Webhook](https://dev.wix.com/api/rest/wix-events/policies-v2/policy-created-webhook)\n - [Policy Updated Webhook](https://dev.wix.com/api/rest/wix-events/policies-v2/policy-updated-webhook)\n - [Policy Deleted Webhook](https://dev.wix.com/api/rest/wix-events/policies-v2/policy-deleted-webhook)\n \n5. When one of the above webhooks is triggered, you'll receive the policy in the payload. You can bring those changes to the ticketing system by retrieving the relevant info from the payload, and use mapping to take action on the external system:\n\n - For updated policies retrieve the `updatedEvent.currentEntityAsJson.id`, `updatedEvent.currentEntityAsJson.body` and/or `updatedEvent.currentEntityAsJson.name` values.\n\n - For created policies retrieve the relevant info from the `createdEvent.currentEntityAsJson` object.\n\n - For deleted policies retrieve the `createdEvent.currentEntityAsJson.id` value.\n"}]},"reviewStatus":"APPROVED","isLocked":true}

Create Policy

Permission Scopes