{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "sync.v1.service.document": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Document resource." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Document resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of resources related to the Sync Document." }, "revision": { "type": "string", "nullable": true, "description": "The current revision of the Sync Document, represented as a string. The `revision` property is used with conditional updates to ensure data consistency." }, "data": { "nullable": true, "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.", "x-twilio": { "pii": { "handling": "sensitive", "deleteSla": 7 } } }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is `null`. The Document resource might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "created_by": { "type": "string", "nullable": true, "description": "The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } }, "sync.v1.service.document.document_permission": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document Permission resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "document_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Sync Document to which the Document Permission applies." }, "identity": { "type": "string", "nullable": true, "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "read": { "type": "boolean", "nullable": true, "description": "Whether the identity can read the Sync Document." }, "write": { "type": "boolean", "nullable": true, "description": "Whether the identity can update the Sync Document." }, "manage": { "type": "boolean", "nullable": true, "description": "Whether the identity can delete the Sync Document." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Sync Document Permission resource." } } }, "sync.v1.service": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Service resource." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 7 } } }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Service resource." }, "webhook_url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL we call when Sync objects are manipulated." }, "webhooks_from_rest_enabled": { "type": "boolean", "nullable": true, "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." }, "reachability_webhooks_enabled": { "type": "boolean", "nullable": true, "description": "Whether the service instance calls `webhook_url` when client endpoints connect to Sync. The default is `false`." }, "acl_enabled": { "type": "boolean", "nullable": true, "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource. It is disabled (false) by default." }, "reachability_debouncing_enabled": { "type": "boolean", "nullable": true, "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event." }, "reachability_debouncing_window": { "type": "integer", "default": 0, "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before `webhook_url` is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "sync.v1.service.sync_stream.stream_message": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TZ[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Stream Message resource." }, "data": { "nullable": true, "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length.", "x-twilio": { "pii": { "handling": "sensitive", "deleteSla": 0 } } } } }, "sync.v1.service.sync_list": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Sync List resource." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Sync List resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of the Sync List's nested resources." }, "revision": { "type": "string", "nullable": true, "description": "The current revision of the Sync List, represented as a string." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the Sync List expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync List does not expire, this value is `null`. The Sync List might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "created_by": { "type": "string", "nullable": true, "description": "The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } }, "sync.v1.service.sync_list.sync_list_item": { "type": "object", "properties": { "index": { "type": "integer", "default": 0, "description": "The automatically generated index of the List Item. The `index` values of the List Items in a Sync List can have gaps in their sequence." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the List Item resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Sync List that contains the List Item." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the List Item resource." }, "revision": { "type": "string", "nullable": true, "description": "The current revision of the item, represented as a string." }, "data": { "nullable": true, "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.", "x-twilio": { "pii": { "handling": "sensitive", "deleteSla": 7 } } }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the List Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the List Item does not expire, this value is `null`. The List Item resource might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "created_by": { "type": "string", "nullable": true, "description": "The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } }, "sync_list_item_enum_query_result_order": { "type": "string", "enum": [ "asc", "desc" ] }, "sync_list_item_enum_query_from_bound_type": { "type": "string", "enum": [ "inclusive", "exclusive" ] }, "sync.v1.service.sync_list.sync_list_permission": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List Permission resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Sync List to which the Permission applies." }, "identity": { "type": "string", "nullable": true, "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "read": { "type": "boolean", "nullable": true, "description": "Whether the identity can read the Sync List and its Items." }, "write": { "type": "boolean", "nullable": true, "description": "Whether the identity can create, update, and delete Items in the Sync List." }, "manage": { "type": "boolean", "nullable": true, "description": "Whether the identity can delete the Sync List." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Sync List Permission resource." } } }, "sync.v1.service.sync_map": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Sync Map resource." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Sync Map resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of the Sync Map's nested resources." }, "revision": { "type": "string", "nullable": true, "description": "The current revision of the Sync Map, represented as a string." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is `null`. The Sync Map might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "created_by": { "type": "string", "nullable": true, "description": "The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } }, "sync.v1.service.sync_map.sync_map_item": { "type": "object", "properties": { "key": { "type": "string", "nullable": true, "description": "The unique, user-defined key for the Map Item.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Map Item resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Sync Map that contains the Map Item." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Map Item resource." }, "revision": { "type": "string", "nullable": true, "description": "The current revision of the Map Item, represented as a string." }, "data": { "nullable": true, "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.", "x-twilio": { "pii": { "handling": "sensitive", "deleteSla": 7 } } }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the Map Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Map Item does not expire, this value is `null`. The Map Item might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "created_by": { "type": "string", "nullable": true, "description": "The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } }, "sync_map_item_enum_query_result_order": { "type": "string", "enum": [ "asc", "desc" ] }, "sync_map_item_enum_query_from_bound_type": { "type": "string", "enum": [ "inclusive", "exclusive" ] }, "sync.v1.service.sync_map.sync_map_permission": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map Permission resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Sync Map to which the Permission applies." }, "identity": { "type": "string", "nullable": true, "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "read": { "type": "boolean", "nullable": true, "description": "Whether the identity can read the Sync Map and its Items." }, "write": { "type": "boolean", "nullable": true, "description": "Whether the identity can create, update, and delete Items in the Sync Map." }, "manage": { "type": "boolean", "nullable": true, "description": "Whether the identity can delete the Sync Map." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Sync Map Permission resource." } } }, "sync.v1.service.sync_stream": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TO[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Sync Stream resource." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Stream resource." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Message Stream resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of the Stream's nested resources." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is `null`. The Stream might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "created_by": { "type": "string", "nullable": true, "description": "The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } } } }, "info": { "title": "Twilio - Sync", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0", "x-twilio": { "apiStandards": "v0.1" } }, "openapi": "3.0.1", "paths": { "/v1/Services/{ServiceSid}/Documents/{Sid}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync Document objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "revision" ], "dependentProperties": { "permissions": { "mapping": { "service_sid": "service_sid", "document_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "SyncV1Document" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Document resource to fetch. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" } } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDocument" }, "delete": { "description": "", "summary": "", "tags": [ "SyncV1Document" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Document resource to delete. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDocument" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1Document" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Document resource to update. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP request header", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" } } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDocumentRequest", "properties": { "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length." }, "Ttl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live)." } } }, "examples": { "update": { "value": { "Data": "{}", "UniqueName": "unique_name", "Ttl": 3600 } } } } } } } }, "/v1/Services/{ServiceSid}/Documents": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync Document objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "revision" ], "dependentProperties": { "permissions": { "mapping": { "service_sid": "service_sid", "document_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1Document" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Document resource in.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" } } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDocumentRequest", "properties": { "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the Sync Document" }, "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length." }, "Ttl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live)." } } }, "examples": { "create": { "value": { "Data": "{}", "UniqueName": "unique_name", "Ttl": 3600 } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "SyncV1Document" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.document" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListDocumentResponse" }, "examples": { "readEmpty": { "value": { "documents": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", "key": "documents", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } }, "readFull": { "value": { "documents": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" } } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", "key": "documents", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDocument" } }, "/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync document permissions", "x-twilio": { "defaultOutputProperties": [ "identity", "read", "write", "manage" ], "parent": "/Services/{ServiceSid}/Documents/{Sid}", "mountName": "document_permissions", "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Document Permission.", "summary": "Fetch a specific Sync Document Permission.", "tags": [ "SyncV1DocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "The SID of the Sync Document with the Document Permission resource to fetch. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Document Permission resource to fetch.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", "summary": "Delete a specific Sync Document Permission.", "tags": [ "SyncV1DocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "The SID of the Sync Document with the Document Permission resource to delete. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Document Permission resource to delete.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", "summary": "Update an identity's access to a specific Sync Document.", "tags": [ "SyncV1DocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "The SID of the Sync Document with the Document Permission resource to update. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Document Permission resource to update.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDocumentPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDocumentPermissionRequest", "properties": { "Read": { "type": "boolean", "description": "Whether the identity can read the Sync Document. Default value is `false`." }, "Write": { "type": "boolean", "description": "Whether the identity can update the Sync Document. Default value is `false`." }, "Manage": { "type": "boolean", "description": "Whether the identity can delete the Sync Document. Default value is `false`." } }, "required": [ "Read", "Write", "Manage" ] }, "examples": { "update": { "value": { "Read": "true", "Write": "true", "Manage": "true" } } } } } } } }, "/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync document permissions", "x-twilio": { "defaultOutputProperties": [ "identity", "read", "write", "manage" ], "parent": "/Services/{ServiceSid}/Documents/{Sid}", "mountName": "document_permissions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Document.", "summary": "Retrieve a list of all Permissions applying to a Sync Document.", "tags": [ "SyncV1DocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "The SID of the Sync Document with the Document Permission resources to read. Can be the Document resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListDocumentPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { "permissions": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDocumentPermission" } }, "/v1/Services/{Sid}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Containers for sync objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], "dependentProperties": { "documents": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Documents" }, "lists": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Lists" }, "maps": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Maps" }, "streams": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Streams" } }, "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "SyncV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Service resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "links": { "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "webhooks_from_rest_enabled": false, "reachability_webhooks_enabled": false, "acl_enabled": false, "reachability_debouncing_enabled": false, "reachability_debouncing_window": 5000 } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchService" }, "delete": { "description": "", "summary": "", "tags": [ "SyncV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Service resource to delete.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteService" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Service resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "links": { "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "webhooks_from_rest_enabled": false, "reachability_webhooks_enabled": false, "acl_enabled": true, "reachability_debouncing_enabled": false, "reachability_debouncing_window": 5000 } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateServiceRequest", "properties": { "WebhookUrl": { "type": "string", "format": "uri", "description": "The URL we should call when Sync objects are manipulated." }, "FriendlyName": { "type": "string", "description": "A string that you assign to describe the resource." }, "ReachabilityWebhooksEnabled": { "type": "boolean", "description": "Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`." }, "AclEnabled": { "type": "boolean", "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource." }, "ReachabilityDebouncingEnabled": { "type": "boolean", "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event." }, "ReachabilityDebouncingWindow": { "type": "integer", "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called." }, "WebhooksFromRestEnabled": { "type": "boolean", "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." } } }, "examples": { "update": { "value": { "FriendlyName": "friendly_name", "WebhookUrl": "http://www.example.com", "AclEnabled": true } } } } } } } }, "/v1/Services": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Containers for sync objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], "dependentProperties": { "documents": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Documents" }, "lists": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Lists" }, "maps": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Maps" }, "streams": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Streams" } }, "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1Service" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "links": { "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "webhooks_from_rest_enabled": false, "reachability_webhooks_enabled": false, "acl_enabled": true, "reachability_debouncing_enabled": false, "reachability_debouncing_window": 5000 } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateServiceRequest", "properties": { "FriendlyName": { "type": "string", "description": "A string that you assign to describe the resource." }, "WebhookUrl": { "type": "string", "format": "uri", "description": "The URL we should call when Sync objects are manipulated." }, "ReachabilityWebhooksEnabled": { "type": "boolean", "description": "Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`." }, "AclEnabled": { "type": "boolean", "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource." }, "ReachabilityDebouncingEnabled": { "type": "boolean", "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event." }, "ReachabilityDebouncingWindow": { "type": "integer", "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the `webhook_url` is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the call to `webhook_url`." }, "WebhooksFromRestEnabled": { "type": "boolean", "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." } } }, "examples": { "create": { "value": { "FriendlyName": "friendly_name", "WebhookUrl": "http://www.example.com", "AclEnabled": true, "ReachabilityDebouncingWindow": 5000 } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "SyncV1Service" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListServiceResponse" }, "examples": { "readEmpty": { "value": { "meta": { "first_page_url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0", "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0" }, "services": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0", "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0" }, "services": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "links": { "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "webhooks_from_rest_enabled": false, "reachability_webhooks_enabled": false, "acl_enabled": false, "reachability_debouncing_enabled": false, "reachability_debouncing_window": 5000 } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "parent": "/Services/{ServiceSid}/Streams/{Sid}", "mountName": "stream_messages", "pathType": "list" }, "post": { "description": "Create a new Stream Message.", "summary": "Create a new Stream Message.", "tags": [ "SyncV1StreamMessage" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Stream Message in.", "schema": { "type": "string" }, "required": true }, { "name": "StreamSid", "in": "path", "description": "The SID of the Sync Stream to create the new Stream Message resource for.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream.stream_message" }, "examples": { "create": { "value": { "sid": "TZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "data": {} } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateStreamMessage", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateStreamMessageRequest", "properties": { "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4 KiB in length." } }, "required": [ "Data" ] }, "examples": { "create": { "value": { "Data": "{}" } } } } } } } }, "/v1/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync list objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "revision" ], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_lists", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Sync List resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncList" }, "delete": { "description": "", "summary": "", "tags": [ "SyncV1SyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Sync List resource to delete. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncList" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Sync List resource to update. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncList", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncListRequest", "properties": { "Ttl": { "type": "integer", "description": "An alias for `collection_ttl`. If both are provided, this value is ignored." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted." } } }, "examples": { "update": { "value": { "Ttl": 3600 } } } } } } } }, "/v1/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync list objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "revision" ], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_lists", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Sync List in.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncList", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncListRequest", "properties": { "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource." }, "Ttl": { "type": "integer", "description": "Alias for collection_ttl. If both are provided, this value is ignored." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted." } } }, "examples": { "create": { "value": { "UniqueName": "unique_name", "Ttl": 3600 } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lists": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_list" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncListResponse" }, "examples": { "readEmpty": { "value": { "lists": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", "key": "lists", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } }, "readFull": { "value": { "lists": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", "key": "lists", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncList" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Items in a sync list", "x-twilio": { "defaultOutputProperties": [ "index", "revision", "created_by" ], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_items", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Item resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Index", "in": "path", "description": "The index of the Sync List Item resource to fetch.", "schema": { "type": "integer" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "index": 100, "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncListItem" }, "delete": { "description": "", "summary": "", "tags": [ "SyncV1SyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Item resource to delete. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Index", "in": "path", "description": "The index of the Sync List Item resource to delete.", "schema": { "type": "integer" }, "required": true }, { "name": "If-Match", "in": "header", "description": "If provided, applies this mutation if (and only if) the \u201crevision\u201d field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncListItem" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Item resource to update. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Index", "in": "path", "description": "The index of the Sync List Item resource to update.", "schema": { "type": "integer" }, "required": true }, { "name": "If-Match", "in": "header", "description": "If provided, applies this mutation if (and only if) the \u201crevision\u201d field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "index": 100, "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncListItemRequest", "properties": { "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length." }, "Ttl": { "type": "integer", "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored." }, "ItemTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request." } } }, "examples": { "update": { "value": { "Data": "{}", "Ttl": 3600 } } } } } } } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Items": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Items in a sync list", "x-twilio": { "defaultOutputProperties": [ "index", "revision", "created_by" ], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_items", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new List Item in.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List to add the new List Item to. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "index": 100, "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncListItemRequest", "properties": { "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length." }, "Ttl": { "type": "integer", "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored." }, "ItemTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted." } }, "required": [ "Data" ] }, "examples": { "create": { "value": { "Data": "{}", "Ttl": 3600 } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the List Item resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the List Items to read. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Order", "in": "query", "description": "How to order the List Items returned by their `index` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending.", "schema": { "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" }, "examples": { "readEmpty": { "value": "asc" }, "readFull": { "value": "asc" } } }, { "name": "From", "in": "query", "description": "The `index` of the first Sync List Item resource to read. See also `bounds`.", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "from" }, "readFull": { "value": "from" } } }, { "name": "Bounds", "in": "query", "description": "Whether to include the List Item referenced by the `from` parameter. Can be: `inclusive` to include the List Item referenced by the `from` parameter or `exclusive` to start with the next List Item. The default value is `inclusive`.", "schema": { "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" }, "examples": { "readEmpty": { "value": "inclusive" }, "readFull": { "value": "inclusive" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncListItemResponse" }, "examples": { "readEmpty": { "value": { "items": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } }, "readFull": { "value": { "items": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "index": 100, "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncListItem" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Permissions for Sync list items", "x-twilio": { "defaultOutputProperties": [ "identity", "read", "write", "manage" ], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_permissions", "pathType": "instance" }, "get": { "description": "Fetch a specific Sync List Permission.", "summary": "Fetch a specific Sync List Permission.", "tags": [ "SyncV1SyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Permission resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Sync List Permission resource to fetch.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", "summary": "Delete a specific Sync List Permission.", "tags": [ "SyncV1SyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Permission resource to delete. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Sync List Permission resource to delete.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", "summary": "Update an identity's access to a specific Sync List.", "tags": [ "SyncV1SyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Permission resource to update. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Sync List Permission resource to update.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncListPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncListPermissionRequest", "properties": { "Read": { "type": "boolean", "description": "Whether the identity can read the Sync List and its Items. Default value is `false`." }, "Write": { "type": "boolean", "description": "Whether the identity can create, update, and delete Items in the Sync List. Default value is `false`." }, "Manage": { "type": "boolean", "description": "Whether the identity can delete the Sync List. Default value is `false`." } }, "required": [ "Read", "Write", "Manage" ] }, "examples": { "update": { "value": { "Read": "true", "Write": "true", "Manage": "true" } } } } } } } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Permissions for Sync list items", "x-twilio": { "defaultOutputProperties": [ "identity", "read", "write", "manage" ], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_permissions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync List.", "summary": "Retrieve a list of all Permissions applying to a Sync List.", "tags": [ "SyncV1SyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "ListSid", "in": "path", "description": "The SID of the Sync List with the Sync List Permission resources to read. Can be the Sync List resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncListPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { "permissions": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncListPermission" } }, "/v1/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync map objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "revision" ], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_maps", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Sync Map resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncMap" }, "delete": { "description": "", "summary": "", "tags": [ "SyncV1SyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Sync Map resource to delete. Can be the Sync Map's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncMap" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Sync Map resource to update. Can be the Sync Map's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncMap", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncMapRequest", "properties": { "Ttl": { "type": "integer", "description": "An alias for `collection_ttl`. If both parameters are provided, this value is ignored." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted." } } }, "examples": { "update": { "value": { "Ttl": 3600 } } } } } } } }, "/v1/Services/{ServiceSid}/Maps": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Sync map objects", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "revision" ], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_maps", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the Sync Map in.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncMap", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncMapRequest", "properties": { "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource." }, "Ttl": { "type": "integer", "description": "An alias for `collection_ttl`. If both parameters are provided, this value is ignored." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted." } } }, "examples": { "create": { "value": { "UniqueName": "unique_name", "Ttl": 3600 } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "maps": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_map" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncMapResponse" }, "examples": { "readEmpty": { "value": { "maps": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", "key": "maps", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } }, "readFull": { "value": { "maps": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", "key": "maps", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncMap" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Keys in a sync map", "x-twilio": { "defaultOutputProperties": [ "key", "revision", "created_by" ], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_items", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The `key` value of the Sync Map Item resource to fetch.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "key": "key", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncMapItem" }, "delete": { "description": "", "summary": "", "tags": [ "SyncV1SyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Item resource to delete. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The `key` value of the Sync Map Item resource to delete.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true }, { "name": "If-Match", "in": "header", "description": "If provided, applies this mutation if (and only if) the \u201crevision\u201d field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncMapItem" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Item resource to update. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The `key` value of the Sync Map Item resource to update. ", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true }, { "name": "If-Match", "in": "header", "description": "If provided, applies this mutation if (and only if) the \u201crevision\u201d field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "key": "key", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncMapItemRequest", "properties": { "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length." }, "Ttl": { "type": "integer", "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored." }, "ItemTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request." } } }, "examples": { "update": { "value": { "Data": "{}", "Ttl": 3600 } } } } } } } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "Keys in a sync map", "x-twilio": { "defaultOutputProperties": [ "key", "revision", "created_by" ], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_items", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "SyncV1SyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the Map Item in.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map to add the new Map Item to. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "key": "key", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncMapItemRequest", "properties": { "Key": { "type": "string", "description": "The unique, user-defined key for the Map Item. Can be up to 320 characters long." }, "Data": { "description": "A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length." }, "Ttl": { "type": "integer", "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored." }, "ItemTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted." }, "CollectionTtl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted." } }, "required": [ "Key", "Data" ] }, "examples": { "create": { "value": { "Data": "{}", "Key": "key", "Ttl": 3600 } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "SyncV1SyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Map Item resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Order", "in": "query", "description": "How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.", "schema": { "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" }, "examples": { "readEmpty": { "value": "asc" }, "readFull": { "value": "asc" } } }, { "name": "From", "in": "query", "description": "The `key` of the first Sync Map Item resource to read. See also `bounds`.", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "from" }, "readFull": { "value": "from" } } }, { "name": "Bounds", "in": "query", "description": "Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.", "schema": { "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" }, "examples": { "readEmpty": { "value": "inclusive" }, "readFull": { "value": "inclusive" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncMapItemResponse" }, "examples": { "readEmpty": { "value": { "items": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } }, "readFull": { "value": { "items": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "key": "key", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncMapItem" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", "read", "write", "manage" ], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_permissions", "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Map Permission.", "summary": "Fetch a specific Sync Map Permission.", "tags": [ "SyncV1SyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resource to fetch. Can be the Service's `sid` value or `default`.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Permission resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Sync Map Permission resource to fetch.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", "summary": "Delete a specific Sync Map Permission.", "tags": [ "SyncV1SyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resource to delete. Can be the Service's `sid` value or `default`.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Permission resource to delete. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Sync Map Permission resource to delete.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", "summary": "Update an identity's access to a specific Sync Map.", "tags": [ "SyncV1SyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resource to update. Can be the Service's `sid` value or `default`.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Sync Map Permission resource to update. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "The application-defined string that uniquely identifies the User's Sync Map Permission resource to update.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncMapPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncMapPermissionRequest", "properties": { "Read": { "type": "boolean", "description": "Whether the identity can read the Sync Map and its Items. Default value is `false`." }, "Write": { "type": "boolean", "description": "Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`." }, "Manage": { "type": "boolean", "description": "Whether the identity can delete the Sync Map. Default value is `false`." } }, "required": [ "Read", "Write", "Manage" ] }, "examples": { "update": { "value": { "Read": "true", "Write": "true", "Manage": "true" } } } } } } } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", "read", "write", "manage" ], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_permissions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Map.", "summary": "Retrieve a list of all Permissions applying to a Sync Map.", "tags": [ "SyncV1SyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resources to read. Can be the Service's `sid` value or `default`.", "schema": { "type": "string" }, "required": true }, { "name": "MapSid", "in": "path", "description": "The SID of the Sync Map with the Permission resources to read. Can be the Sync Map resource's `sid` or its `unique_name`.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncMapPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { "permissions": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncMapPermission" } }, "/v1/Services/{ServiceSid}/Streams/{Sid}": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], "dependentProperties": { "messages": { "mapping": { "service_sid": "service_sid", "stream_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Streams/{stream_sid}/Messages" } }, "parent": "/Services/{Sid}", "mountName": "sync_streams", "pathType": "instance" }, "get": { "description": "Fetch a specific Stream.", "summary": "Fetch a specific Stream.", "tags": [ "SyncV1SyncStream" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Stream resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" }, "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncStream" }, "delete": { "description": "Delete a specific Stream.", "summary": "Delete a specific Stream.", "tags": [ "SyncV1SyncStream" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to delete.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Stream resource to delete.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncStream" }, "post": { "description": "Update a specific Stream.", "summary": "Update a specific Stream.", "tags": [ "SyncV1SyncStream" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Stream resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" }, "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncStream", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncStreamRequest", "properties": { "Ttl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live)." } } }, "examples": { "update": { "value": { "Ttl": 3600 } } } } } } } }, "/v1/Services/{ServiceSid}/Streams": { "servers": [ { "url": "https://sync.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], "dependentProperties": { "messages": { "mapping": { "service_sid": "service_sid", "stream_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Streams/{stream_sid}/Messages" } }, "parent": "/Services/{Sid}", "mountName": "sync_streams", "pathType": "list" }, "post": { "description": "Create a new Stream.", "summary": "Create a new Stream.", "tags": [ "SyncV1SyncStream" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Stream in.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" }, "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncStream", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncStreamRequest", "properties": { "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource." }, "Ttl": { "type": "integer", "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live)." } } }, "examples": { "create": { "value": { "UniqueName": "unique_name", "Ttl": 3600 } } } } } } }, "get": { "description": "Retrieve a list of all Streams in a Service Instance.", "summary": "Retrieve a list of all Streams in a Service Instance.", "tags": [ "SyncV1SyncStream" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Stream resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "streams": { "type": "array", "items": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListSyncStreamResponse" }, "examples": { "readEmpty": { "value": { "streams": [], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0", "key": "streams", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0" } } }, "readFull": { "value": { "streams": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_expires": "2015-07-30T21:00:00Z", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" }, "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0", "key": "streams", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncStream" } } }, "servers": [ { "url": "https://sync.twilio.com" } ], "tags": [ { "name": "SyncV1Document" }, { "name": "SyncV1DocumentPermission" }, { "name": "SyncV1Index" }, { "name": "SyncV1Service" }, { "name": "SyncV1StreamMessage" }, { "name": "SyncV1SyncList" }, { "name": "SyncV1SyncListItem" }, { "name": "SyncV1SyncListPermission" }, { "name": "SyncV1SyncMap" }, { "name": "SyncV1SyncMapItem" }, { "name": "SyncV1SyncMapPermission" }, { "name": "SyncV1SyncStream" }, { "name": "SyncV1Version" } ], "security": [ { "accountSid_authToken": [] } ] }