From 3aab47222bc54b37bba1ab78d4fa36e197176d48 Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Tue, 6 Jun 2023 17:09:57 +0300 Subject: [PATCH 1/2] Auto commit from WixDocs server --- all/all-apis/events---policies.service.json | 1054 +++++++++++++++++++ 1 file changed, 1054 insertions(+) create mode 100644 all/all-apis/events---policies.service.json diff --git a/all/all-apis/events---policies.service.json b/all/all-apis/events---policies.service.json new file mode 100644 index 0000000000..e6e8e27512 --- /dev/null +++ b/all/all-apis/events---policies.service.json @@ -0,0 +1,1054 @@ +{ + "name": "Events - Policies", + "client_id": "https://github.com/wix-private/events/tree/master/wix-events-platform-api/events-policies-v1/src/main/proto#public", + "memberOf": "All APIs", + "category": "business-service", + "mixes": [], + "labels": [], + "docs": { + "summary": "API to manage policies", + "description": [] + }, + "properties": [], + "tags": [ { + "name": "Policy", + "entity": "_wix_events_Policy", + "src": "https://github.com/wix-private/events/tree/master/wix-events-platform-api/events-policies-v1/wix/events/Policy.proto" + }], + "relatedGuides": [ { + "path": "../guides/events---policies/docs/intro.md", + "name": "Introduction" + }], + "operations": [ + { + "name": "Create Policy", + "methodName": "CreatePolicy", + "serviceName": "PolicyManagement", + "tag": "Policy", + "permissions": [ { + "name": "Manage Policies", + "description": "Request permission to read, create and change events policies." + }], + "events": [], + "labels": [], + "nameParams": [], + "requiredFields": [ + "eventId", + "policy", + "policy.name", + "policy.body" + ], + "params": [ + { + "in": "BODY", + "name": "eventId", + "type": "string", + "doc": " Event ID.\n", + "required": true + }, + { + "in": "BODY", + "name": "policy", + "type": "All APIs.Events - Policies._wix_events_policies_PolicyData", + "doc": " Policy data.\n", + "required": true + } + ], + "ret": { + "type": { + "name": "CreatePolicy", + "statusCode": "200", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_CreatePolicyResponse"] + }, + "doc": "" + }, + "locations": [], + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n Creates a policy for an event.\n Each event can have up to 3 policies.\n \n", + "description": [], + "request": "POST", + "url": "https://www.wixapis.com/events/v1/policies", + "links": [], + "examples": [ { + "title": "", + "body": ["curl -X POST 'https://www.wixapis.com/events/v1/policies' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d @- << EOF\n{\n \"eventId\": \"b16f3b55-78a5-4fff-8098-ddafa0607eea\",\n \"policy\": {\n \"name\": \"Terms and conditions\",\n \"body\": \"Agree to something\"\n }\n}\nEOF"], + "response": ["{\"policy\": {\n \"id\": \"9ece22be-3875-4ab2-8d8e-330417bfc5b0\",\n \"name\": \"Terms and conditions\",\n \"body\": \"Agree to something\",\n \"updatedDate\": \"2020-07-15T09:29:56.592Z\",\n \"sortIndex\": 3\n}} "], + "type": "curl", + "extra": {} + }], + "extra": {} + }, + "extra": { + "hasRest": true, + "rpcRequestName": "CreatePolicyRequest", + "rpcResponseName": "CreatePolicyResponse" + }, + "customLabels": [] + }, + { + "name": "Delete Policy", + "methodName": "DeletePolicy", + "serviceName": "PolicyManagement", + "tag": "Policy", + "permissions": [ { + "name": "Manage Policies", + "description": "Request permission to read, create and change events policies." + }], + "events": [], + "labels": [], + "nameParams": [], + "requiredFields": [ + "eventId", + "policyId" + ], + "params": [ + { + "in": "PATH", + "name": "policyId", + "type": "string", + "doc": " Policy ID.\n", + "required": true + }, + { + "in": "BODY", + "name": "eventId", + "type": "string", + "doc": " Event ID.\n", + "required": true + } + ], + "ret": { + "type": { + "name": "DeletePolicy", + "statusCode": "200", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_DeletePolicyResponse"] + }, + "doc": "" + }, + "locations": [], + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n Deletes a policy.\n \n", + "description": [], + "request": "DELETE", + "url": "https://www.wixapis.com/events/v1/policies/{policyId}", + "links": [], + "examples": [ { + "title": "", + "body": ["curl -X DELETE 'https://www.wixapis.com/events/v1/policies/0ace566b-ab83-4f7f-ae24-f401d94e81a4' \\\n-H 'Authorization: ' \\"], + "response": ["{} "], + "type": "curl", + "extra": {} + }], + "extra": {} + }, + "extra": { + "hasRest": true, + "rpcRequestName": "DeletePolicyRequest", + "rpcResponseName": "DeletePolicyResponse" + }, + "customLabels": [] + }, + { + "name": "Get Tokens", + "methodName": "GetTokens", + "serviceName": "PolicyManagement", + "tag": "Policy", + "permissions": [ { + "name": "Read Policies", + "description": "Request permission to read basic events policy info." + }], + "events": [], + "labels": [], + "nameParams": [], + "params": [ + { + "in": "QUERY", + "name": "eventId", + "type": { + "name": "array", + "typeParams": ["string"] + }, + "doc": " Event ID.\n", + "required": false + }, + { + "in": "QUERY", + "name": "tokensFieldset", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_TokensFieldset"] + }, + "doc": " Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_token-fieldset).\n", + "required": false + }, + { + "in": "QUERY", + "name": "policyFieldset", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_PolicyFieldset"] + }, + "doc": " Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_policy-fieldset).\n", + "required": false + } + ], + "ret": { + "type": { + "name": "GetTokens", + "statusCode": "200", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_GetTokensResponse"] + }, + "doc": "" + }, + "locations": [], + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n Retrieves policy agreement tokens for the given event IDs, including a list of policies if POLICIES fieldset is provided.\n Tokens are hashes generated from all an event's policies, and must be passed during checkout and RSVP registration in order to validate approval of the event's policies.\n \n", + "description": [], + "request": "GET", + "url": "https://www.wixapis.com/events/v1/policies/tokens", + "links": [], + "examples": [ { + "title": "", + "body": ["curl -X GET 'https://www.wixapis.com/events/v1/policies/tokens?tokensFieldset=POLICIES&policyFieldset=BODY&eventId=54bb06d8-467b-4c57-831f-cb3c04874044' \\\n-H 'Authorization: ' \\"], + "response": ["{\n \"tokens\": {\"54bb06d8-467b-4c57-831f-cb3c04874044\": \"6398f1ce06c6581fb6df54067277b145\"},\n \"policies\": [\n {\n \"id\": \"49365385-d154-493a-9518-3b355495f08e\",\n \"name\": \"Policy 1\",\n \"body\": \"

Event policy text<\\/p>\",\n \"updatedDate\": \"2020-07-23T08:43:08.061Z\",\n \"sortIndex\": 1,\n \"eventId\": \"54bb06d8-467b-4c57-831f-cb3c04874044\"\n },\n {\n \"id\": \"91c95b4f-e1a1-4434-b92d-1bfc6d0d62c6\",\n \"name\": \"Policy 2\",\n \"body\": \"

Event policy text<\\/p>\",\n \"updatedDate\": \"2020-07-28T17:13:26.500Z\",\n \"sortIndex\": 2,\n \"eventId\": \"54bb06d8-467b-4c57-831f-cb3c04874044\"\n }\n ]\n} "], + "type": "curl", + "extra": {} + }], + "extra": {} + }, + "extra": { + "hasRest": true, + "rpcRequestName": "GetTokensRequest", + "rpcResponseName": "GetTokensResponse" + }, + "customLabels": [] + }, + { + "name": "Query Policies", + "methodName": "QueryPolicies", + "serviceName": "PolicyManagement", + "tag": "Policy", + "permissions": [ { + "name": "Read Policies", + "description": "Request permission to read basic events policy info." + }], + "events": [], + "labels": [], + "nameParams": [], + "params": [ + { + "in": "BODY", + "name": "offset", + "type": "integer", + "doc": " Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n", + "required": false + }, + { + "in": "BODY", + "name": "limit", + "type": "integer", + "doc": " Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n", + "required": false + }, + { + "in": "BODY", + "name": "filter", + "type": "struct", + "doc": " Filter.\n", + "required": false + }, + { + "in": "BODY", + "name": "fieldset", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_PolicyFieldset"] + }, + "doc": " Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_policy-fieldset).\n", + "required": false + } + ], + "ret": { + "type": { + "name": "QueryPolicies", + "statusCode": "200", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_QueryPoliciesResponse"] + }, + "doc": "" + }, + "locations": [], + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n Retrieves a list of policies, given the provided paging and filter.\n \n", + "description": [], + "request": "POST", + "url": "https://www.wixapis.com/events/v1/policies/query", + "links": [], + "examples": [ { + "title": "", + "body": ["curl -X POST 'https://www.wixapis.com/events/v1/policies/query?fieldset=BODY' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"offset\": 0,\n \"limit\": 2,\n \"filter\": {\n \"eventId\": {\n \"$hasSome\": [ \"54bb06d8-467b-4c57-831f-cb3c04874044\" ]\n }\n }\n }'\n\n{\n \"metaData\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 6\n },\n \"policies\": [\n {\n \"id\": \"49365385-d154-493a-9518-3b355495f08e\",\n \"name\": \"Policy 1\",\n \"body\": \"

Event policy text<\/p>\",\n \"updatedDate\": \"2020-07-23T08:43:08.061Z\",\n \"sortIndex\": 1,\n \"eventId\": \"54bb06d8-467b-4c57-831f-cb3c04874044\"\n },\n {\n \"id\": \"91c95b4f-e1a1-4434-b92d-1bfc6d0d62c6\",\n \"name\": \"Policy 2\",\n \"body\": \"

Event policy text<\/p>\",\n \"updatedDate\": \"2020-07-28T17:13:26.500Z\",\n \"sortIndex\": 2,\n \"eventId\": \"54bb06d8-467b-4c57-831f-cb3c04874044\"\n }\n ]\n}\n"], + "response": ["{} "], + "type": "curl", + "extra": {} + }], + "extra": {} + }, + "extra": { + "hasRest": true, + "rpcRequestName": "QueryPoliciesRequest", + "rpcResponseName": "QueryPoliciesResponse" + }, + "customLabels": [] + }, + { + "name": "Update Policy", + "methodName": "UpdatePolicy", + "serviceName": "PolicyManagement", + "tag": "Policy", + "permissions": [ { + "name": "Manage Policies", + "description": "Request permission to read, create and change events policies." + }], + "events": [], + "labels": [], + "nameParams": [], + "requiredFields": [ + "eventId", + "policyId", + "policy", + "policy.name", + "policy.body" + ], + "params": [ + { + "in": "PATH", + "name": "policyId", + "type": "string", + "doc": " Policy ID.\n", + "required": true + }, + { + "in": "BODY", + "name": "eventId", + "type": "string", + "doc": " Event ID.\n", + "required": true + }, + { + "in": "BODY", + "name": "policy", + "type": "All APIs.Events - Policies._wix_events_policies_PolicyData", + "doc": " Policy data.\n", + "required": true + } + ], + "ret": { + "type": { + "name": "UpdatePolicy", + "statusCode": "200", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_UpdatePolicyResponse"] + }, + "doc": "" + }, + "locations": [], + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n Updates a policy.\n \n", + "description": [], + "request": "PATCH", + "url": "https://www.wixapis.com/events/v1/policies/{policyId}", + "links": [], + "examples": [ { + "title": "", + "body": ["curl -X PATCH 'https://www.wixapis.com/events/v1/policies/0ace566b-ab83-4f7f-ae24-f401d94e81a4' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d @- << EOF\n{\n \"eventId\": \"b16f3b55-78a5-4fff-8098-ddafa0607eea\",\n \"policyId\": \"0ace566b-ab83-4f7f-ae24-f401d94e81a4\",\n \"policy\": {\n \"name\": \"Terms and conditions\",\n \"body\": \"Agree to something\",\n \"sortIndex\": 3\n }\n}\nEOF"], + "response": ["{\"policy\": {\n \"id\": \"0ace566b-ab83-4f7f-ae24-f401d94e81a4\",\n \"name\": \"Terms and conditions\",\n \"body\": \"Agree to something\",\n \"updatedDate\": \"2020-07-15T09:33:13.208Z\",\n \"sortIndex\": 3\n}} "], + "type": "curl", + "extra": {} + }], + "extra": {} + }, + "extra": { + "hasRest": true, + "rpcRequestName": "UpdatePolicyRequest", + "rpcResponseName": "UpdatePolicyResponse" + }, + "customLabels": [] + } + ], + "events": [ + { + "type": "_wix_events_PolicyCreatedDomainEvent", + "name": "Policy Created Webhook", + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n", + "src": "https://github.com/wix-private/events/tree/master/wix-events-platform-api/events-policies-v1/src/main/proto/wix/events/policies/PolicyManagement.proto" + }, + "topic": "domain_events_wix.events.v1.policy", + "tag": "Policy", + "permissions": [], + "customLabels": [], + "eventType": "wix.events.v1.policy_created", + "extra": {"isDomainEvent": true} + }, + { + "type": "_wix_events_PolicyDeletedDomainEvent", + "name": "Policy Deleted Webhook", + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n", + "src": "https://github.com/wix-private/events/tree/master/wix-events-platform-api/events-policies-v1/src/main/proto/wix/events/policies/PolicyManagement.proto" + }, + "topic": "domain_events_wix.events.v1.policy", + "tag": "Policy", + "permissions": [], + "customLabels": [], + "eventType": "wix.events.v1.policy_deleted", + "extra": {"isDomainEvent": true} + }, + { + "type": "_wix_events_PolicyUpdatedDomainEvent", + "name": "Policy Updated Webhook", + "docs": { + "summary": "\n > **Deprecation Notice**\n >\n > **The Policies v1 API has been replaced with\n > [Policies v2](https://dev.wix.com/api/rest/wix-events/policies-v2)\n > and will be removed on August 01, 2023. If your app uses this endpoint,\n > we recommend updating your code as soon as possible.**\n\n", + "src": "https://github.com/wix-private/events/tree/master/wix-events-platform-api/events-policies-v1/src/main/proto/wix/events/policies/PolicyManagement.proto" + }, + "topic": "domain_events_wix.events.v1.policy", + "tag": "Policy", + "permissions": [], + "customLabels": [], + "eventType": "wix.events.v1.policy_updated", + "extra": {"isDomainEvent": true} + } + ], + "callbacks": [], + "messages": [ + { + "name": "_wix_events_PolicyCreatedDomainEvent", + "displayName": "Policy Created Domain Event Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "id", + "type": "string", + "doc": "Unique event ID." + }, + { + "name": "entityFqdn", + "type": "string", + "doc": "Expected `wix.events.v1.policy`.\nFully Qualified Domain Name." + }, + { + "name": "slug", + "type": "string", + "doc": "Expected `created`.\nEvent name." + }, + { + "name": "createdEvent", + "type": "All APIs.Events - Policies._wix_events_PolicyEntityCreatedEvent", + "doc": "Event Info" + }, + { + "name": "entityId", + "type": "string", + "doc": "Policy ID associated with this event." + }, + { + "name": "eventTime", + "type": "string", + "doc": "Event timestamp." + }, + { + "name": "triggeredByAnonymizeRequest", + "type": "boolean", + "doc": "Whether this event was triggered as a result of a privacy regulation application (e.g., GDPR)." + }, + { + "name": "originatedFrom", + "type": "string", + "doc": "If present, indicates the action that triggered the event." + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_PolicyEntityCreatedEvent", + "displayName": "Policy Entity Created Event Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ { + "name": "entity", + "type": "All APIs.Events - Policies._wix_events_Policy", + "doc": "Event body" + }], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_PolicyDeletedDomainEvent", + "displayName": "Policy Deleted Domain Event Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "id", + "type": "string", + "doc": "Unique event ID." + }, + { + "name": "entityFqdn", + "type": "string", + "doc": "Expected `wix.events.v1.policy`.\nFully Qualified Domain Name." + }, + { + "name": "slug", + "type": "string", + "doc": "Expected `deleted`.\nEvent name." + }, + { + "name": "deletedEvent", + "type": "All APIs.Events - Policies._wix_events_PolicyEntityDeletedEvent", + "doc": "Event Info" + }, + { + "name": "entityId", + "type": "string", + "doc": "Policy ID associated with this event." + }, + { + "name": "eventTime", + "type": "string", + "doc": "Event timestamp." + }, + { + "name": "triggeredByAnonymizeRequest", + "type": "boolean", + "doc": "Whether this event was triggered as a result of a privacy regulation application (e.g., GDPR)." + }, + { + "name": "originatedFrom", + "type": "string", + "doc": "If present, indicates the action that triggered the event." + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_PolicyEntityDeletedEvent", + "displayName": "Policy Entity Deleted Event Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_PolicyUpdatedDomainEvent", + "displayName": "Policy Updated Domain Event Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "id", + "type": "string", + "doc": "Unique event ID." + }, + { + "name": "entityFqdn", + "type": "string", + "doc": "Expected `wix.events.v1.policy`.\nFully Qualified Domain Name." + }, + { + "name": "slug", + "type": "string", + "doc": "Expected `updated`.\nEvent name." + }, + { + "name": "updatedEvent", + "type": "All APIs.Events - Policies._wix_events_PolicyEntityUpdatedEvent", + "doc": "Event Info" + }, + { + "name": "entityId", + "type": "string", + "doc": "Policy ID associated with this event." + }, + { + "name": "eventTime", + "type": "string", + "doc": "Event timestamp." + }, + { + "name": "triggeredByAnonymizeRequest", + "type": "boolean", + "doc": "Whether this event was triggered as a result of a privacy regulation application (e.g., GDPR)." + }, + { + "name": "originatedFrom", + "type": "string", + "doc": "If present, indicates the action that triggered the event." + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_PolicyEntityUpdatedEvent", + "displayName": "Policy Entity Updated Event Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ { + "name": "currentEntity", + "type": "All APIs.Events - Policies._wix_events_Policy", + "doc": "Event body" + }], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_Policy", + "displayName": "Policy Object", + "locations": [], + "docs": { + "summary": "\n> **Deprecation Notice**\n>\n> **The Policies v1 API has been replaced with\n> [Policy v2](https://dev.wix.com/api/rest/wix-events/policy-v2)\n> and will be removed on August 01, 2023. If your app uses this endpoint,\n> we recommend updating your code as soon as possible.**\n", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "id", + "type": "string", + "doc": " Policy ID (generated automatically)\n", + "readOnly": true + }, + { + "name": "name", + "type": "string", + "doc": " Policy name.\n" + }, + { + "name": "body", + "type": "string", + "doc": " Policy body.\n" + }, + { + "name": "updatedDate", + "type": "string", + "doc": " Date policy was updated.\n" + }, + { + "name": "sortIndex", + "type": "integer", + "doc": " Custom sort index.\n" + }, + { + "name": "eventId", + "type": "string", + "doc": " Event ID.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_ResponseMetaData", + "displayName": "Response Meta Data Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "count", + "type": "integer", + "doc": " Number of items in the response.\n" + }, + { + "name": "offset", + "type": "integer", + "doc": " Offset of items.\n" + }, + { + "name": "total", + "type": "integer", + "doc": " Total number of matching items.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_PolicyData", + "displayName": "Policy Data Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "name", + "type": "string", + "doc": " Policy name.\n" + }, + { + "name": "body", + "type": "string", + "doc": " Policy body.\n" + }, + { + "name": "sortIndex", + "type": "integer", + "doc": " Custom sort index.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_CreatePolicyRequest", + "displayName": "Create Policy Request Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "eventId", + "type": "string", + "doc": " Event ID.\n" + }, + { + "name": "policy", + "type": "All APIs.Events - Policies._wix_events_policies_PolicyData", + "doc": " Policy data.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_CreatePolicyResponse", + "displayName": "Create Policy Response Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ { + "name": "policy", + "type": "All APIs.Events - Policies._wix_events_Policy", + "doc": " Created policy.\n" + }], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_UpdatePolicyRequest", + "displayName": "Update Policy Request Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "eventId", + "type": "string", + "doc": " Event ID.\n" + }, + { + "name": "policyId", + "type": "string", + "doc": " Policy ID.\n" + }, + { + "name": "policy", + "type": "All APIs.Events - Policies._wix_events_policies_PolicyData", + "doc": " Policy data.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_UpdatePolicyResponse", + "displayName": "Update Policy Response Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ { + "name": "policy", + "type": "All APIs.Events - Policies._wix_events_Policy", + "doc": " Updated policy.\n" + }], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_DeletePolicyRequest", + "displayName": "Delete Policy Request Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "eventId", + "type": "string", + "doc": " Event ID.\n" + }, + { + "name": "policyId", + "type": "string", + "doc": " Policy ID.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_DeletePolicyResponse", + "displayName": "Delete Policy Response Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_QueryPoliciesRequest", + "displayName": "Query Policies Request Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "offset", + "type": "integer", + "doc": " Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n" + }, + { + "name": "limit", + "type": "integer", + "doc": " Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n" + }, + { + "name": "filter", + "type": "struct", + "doc": " Filter.\n" + }, + { + "name": "fieldset", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_PolicyFieldset"] + }, + "doc": " Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_policy-fieldset).\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_QueryPoliciesResponse", + "displayName": "Query Policies Response Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "metaData", + "type": "All APIs.Events - Policies._wix_events_ResponseMetaData", + "doc": " Meta data of query results.\n" + }, + { + "name": "policies", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_Policy"] + }, + "doc": " List of event policies.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_GetTokensRequest", + "displayName": "Get Tokens Request Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "eventId", + "type": { + "name": "array", + "typeParams": ["string"] + }, + "doc": " Event ID.\n" + }, + { + "name": "tokensFieldset", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_TokensFieldset"] + }, + "doc": " Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_token-fieldset).\n" + }, + { + "name": "policyFieldset", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_policies_PolicyFieldset"] + }, + "doc": " Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_policy-fieldset).\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "tokensMapEntry", + "displayName": "tokens Map Entry Object", + "locations": [], + "docs": { + "summary": "Set of key-value pairs. Policy tokens by event ID.\n Used to validate policy agreement on RSVP or Checkout.\n Token is changed every time an event policy is updated.\n", + "links": [], + "examples": [] + }, + "members": [ { + "name": "key:value", + "type": "string", + "doc": "`key` of type string, `value` of type string" + }], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_GetTokensResponse", + "displayName": "Get Tokens Response Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ + { + "name": "tokens", + "type": "All APIs.Events - Policies.tokensMapEntry", + "doc": "Set of key-value pairs. Policy tokens by event ID.\n Used to validate policy agreement on RSVP or Checkout.\n Token is changed every time an event policy is updated.\n" + }, + { + "name": "policies", + "type": { + "name": "array", + "typeParams": ["All APIs.Events - Policies._wix_events_Policy"] + }, + "doc": " Event policies.\n" + } + ], + "enum": null, + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_PolicyFieldset", + "displayName": "Policy Fieldset Object", + "locations": [], + "docs": { + "summary": " \n Possible values are:

  • BODY - Include policy body in the response.\n <\/code><\/li>", + "links": [], + "examples": [] + }, + "members": [], + "enum": ["BODY"], + "extra": {}, + "labels": [] + }, + { + "name": "_wix_events_policies_TokensFieldset", + "displayName": "Tokens Fieldset Object", + "locations": [], + "docs": { + "summary": " \n Possible values are:
  • POLICIES - Include policies in the response.\n <\/code><\/li>", + "links": [], + "examples": [] + }, + "members": [], + "enum": ["POLICIES"], + "extra": {}, + "labels": [] + } + ], + "extra": {"artifactId": "com.wixpress.events.events-policy-management-v1-proxy"} +} \ No newline at end of file From f9dd715ff48aa383d3db39c0b78b35616e21a408 Mon Sep 17 00:00:00 2001 From: Wixplorer Date: Tue, 6 Jun 2023 17:09:59 +0300 Subject: [PATCH 2/2] Auto commit from WixDocs server --- all/guides/events---policies/docs/intro.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 all/guides/events---policies/docs/intro.md diff --git a/all/guides/events---policies/docs/intro.md b/all/guides/events---policies/docs/intro.md new file mode 100644 index 0000000000..2e0b7dae5d --- /dev/null +++ b/all/guides/events---policies/docs/intro.md @@ -0,0 +1,7 @@ +SortOrder: 0 +# Introduction + +A service which allows to configure event policies. + +Policies are free-text conditions, refund & exchanges and/or other information, as relevant. +During registration, guests are asked to agree to such conditions. \ No newline at end of file