{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "preview.hosted_numbers.authorization_document": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this AuthorizationDocument." }, "address_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, "status": { "type": "string", "$ref": "#/components/schemas/authorization_document_enum_status", "nullable": true, "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." }, "email": { "type": "string", "nullable": true, "description": "Email that this AuthorizationDocument will be sent to for signing.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "cc_emails": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "authorization_document_enum_status": { "type": "string", "enum": [ "opened", "signing", "signed", "canceled", "failed" ] }, "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Authorization Document" }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account." }, "incoming_phone_number_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." }, "address_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." }, "signing_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, "description": "An E164 formatted phone number hosted by this HostedNumberOrder." }, "capabilities": { "type": "object", "format": "phone-number-capabilities", "x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)", "properties": { "mms": { "type": "boolean" }, "sms": { "type": "boolean" }, "voice": { "type": "boolean" }, "fax": { "type": "boolean" } }, "nullable": true, "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." }, "friendly_name": { "type": "string", "nullable": true, "description": "A human readable description of this resource, up to 64 characters.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "unique_name": { "type": "string", "nullable": true, "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "status": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", "nullable": true, "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." }, "failure_reason": { "type": "string", "nullable": true, "description": "A message that explains why a hosted_number_order went to status \"action-required\"" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "verification_attempts": { "type": "integer", "default": 0, "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, "email": { "type": "string", "nullable": true, "description": "Email of the owner of this phone number that is being hosted.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "cc_emails": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "verification_type": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", "nullable": true, "description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." }, "verification_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." }, "extension": { "type": "string", "nullable": true, "description": "A numerical extension to be used when making the ownership verification call." }, "call_delay": { "type": "integer", "default": 0, "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, "verification_code": { "type": "string", "nullable": true, "description": "The digits passed during the ownership verification call." }, "verification_call_sids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } }, "dependent_hosted_number_order_enum_status": { "type": "string", "enum": [ "received", "pending-verification", "verified", "pending-loa", "carrier-processing", "testing", "completed", "failed", "action-required" ] }, "dependent_hosted_number_order_enum_verification_type": { "type": "string", "enum": [ "phone-call", "phone-bill" ] }, "preview.hosted_numbers.hosted_number_order": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this HostedNumberOrder." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the account." }, "incoming_phone_number_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted." }, "address_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." }, "signing_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" }, "capabilities": { "type": "object", "format": "phone-number-capabilities", "x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)", "properties": { "mms": { "type": "boolean" }, "sms": { "type": "boolean" }, "voice": { "type": "boolean" }, "fax": { "type": "boolean" } }, "nullable": true, "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." }, "friendly_name": { "type": "string", "nullable": true, "description": "A 64 character string that is a human-readable text that describes this resource.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "unique_name": { "type": "string", "nullable": true, "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "status": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_status", "nullable": true, "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses." }, "failure_reason": { "type": "string", "nullable": true, "description": "A message that explains why a hosted_number_order went to status \"action-required\"" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "verification_attempts": { "type": "integer", "default": 0, "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, "email": { "type": "string", "nullable": true, "description": "Email of the owner of this phone number that is being hosted.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "cc_emails": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this HostedNumberOrder." }, "verification_type": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", "nullable": true, "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." }, "verification_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." }, "extension": { "type": "string", "nullable": true, "description": "A numerical extension to be used when making the ownership verification call." }, "call_delay": { "type": "integer", "default": 0, "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, "verification_code": { "type": "string", "nullable": true, "description": "A verification code provided in the response for a user to enter when they pick up the phone call." }, "verification_call_sids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } }, "hosted_number_order_enum_status": { "type": "string", "enum": [ "received", "pending-verification", "verified", "pending-loa", "carrier-processing", "testing", "completed", "failed", "action-required" ] }, "hosted_number_order_enum_verification_type": { "type": "string", "enum": [ "phone-call", "phone-bill" ] }, "preview.marketplace.available_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the AvailableAddOn resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "description": { "type": "string", "nullable": true, "description": "A short description of the Add-on's functionality." }, "pricing_type": { "type": "string", "nullable": true, "description": "How customers are charged for using this Add-on." }, "configuration_schema": { "nullable": true, "description": "The JSON object with the configuration that must be provided when installing a given Add-on." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "preview.marketplace.available_add_on.available_add_on_extension": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the AvailableAddOnExtension resource." }, "available_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the AvailableAddOn resource to which this extension applies." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", "nullable": true, "description": "The name of the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "preview.marketplace.installed_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'." }, "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 InstalledAddOn resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "description": { "type": "string", "nullable": true, "description": "A short description of the Add-on's functionality." }, "configuration": { "nullable": true, "description": "The JSON object that represents the current configuration of installed Add-on." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource." }, "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 resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "preview.marketplace.installed_add_on.installed_add_on_extension": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the InstalledAddOn Extension resource." }, "installed_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the InstalledAddOn resource to which this extension applies." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", "nullable": true, "description": "The name of the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource." }, "enabled": { "type": "boolean", "nullable": true, "description": "Whether the Extension will be invoked." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "preview.sync.service.document": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true }, "revision": { "type": "string", "nullable": true }, "data": { "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string", "nullable": true } } }, "preview.sync.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 unique SID identifier of the Twilio Account." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Sync Service Instance." }, "document_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Sync Document to which the Permission applies." }, "identity": { "type": "string", "nullable": true, "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, "read": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can read the Sync Document." }, "write": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can update the Sync Document." }, "manage": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can delete the Sync Document." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Sync Document Permission." } } }, "preview.sync.service": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "webhook_url": { "type": "string", "format": "uri", "nullable": true }, "reachability_webhooks_enabled": { "type": "boolean", "nullable": true }, "acl_enabled": { "type": "boolean", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "preview.sync.service.sync_list": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true }, "revision": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string", "nullable": true } } }, "preview.sync.service.sync_list.sync_list_item": { "type": "object", "properties": { "index": { "type": "integer", "default": 0 }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "revision": { "type": "string", "nullable": true }, "data": { "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string", "nullable": true } } }, "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" ] }, "preview.sync.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 unique SID identifier of the Twilio Account." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Sync Service Instance." }, "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Sync List to which the Permission applies." }, "identity": { "type": "string", "nullable": true, "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, "read": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can read the Sync List and its Items." }, "write": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, "manage": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can delete the Sync List." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Sync List Permission." } } }, "preview.sync.service.sync_map": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true }, "revision": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string", "nullable": true } } }, "preview.sync.service.sync_map.sync_map_item": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "revision": { "type": "string", "nullable": true }, "data": { "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string", "nullable": true } } }, "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" ] }, "preview.sync.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 unique SID identifier of the Twilio Account." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Sync Service Instance." }, "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Sync Map to which the Permission applies." }, "identity": { "type": "string", "nullable": true, "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, "read": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can read the Sync Map and its Items." }, "write": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, "manage": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying whether the identity can delete the Sync Map." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Sync Map Permission." } } }, "preview.wireless.command": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DC[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, "command": { "type": "string", "nullable": true }, "command_mode": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "direction": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "preview.wireless.rate_plan": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "data_enabled": { "type": "boolean", "nullable": true }, "data_metering": { "type": "string", "nullable": true }, "data_limit": { "type": "integer", "default": 0 }, "messaging_enabled": { "type": "boolean", "nullable": true }, "voice_enabled": { "type": "boolean", "nullable": true }, "national_roaming_enabled": { "type": "boolean", "nullable": true }, "international_roaming": { "type": "array", "items": { "type": "string" }, "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "preview.wireless.sim": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "rate_plan_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "iccid": { "type": "string", "nullable": true }, "e_id": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "commands_callback_url": { "type": "string", "format": "uri", "nullable": true }, "commands_callback_method": { "type": "string", "nullable": true }, "sms_fallback_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true }, "sms_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true }, "sms_url": { "type": "string", "format": "uri", "nullable": true }, "voice_fallback_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true }, "voice_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true }, "voice_url": { "type": "string", "format": "uri", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "preview.wireless.sim.usage": { "type": "object", "properties": { "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, "sim_unique_name": { "type": "string", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "period": { "nullable": true }, "commands_usage": { "nullable": true }, "commands_costs": { "nullable": true }, "data_usage": { "nullable": true }, "data_costs": { "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } } } }, "info": { "title": "Twilio - Preview", "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" }, "openapi": "3.0.1", "paths": { "/HostedNumbers/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { "signing_document_sid": "sid" }, "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } }, "pathType": "instance" }, "get": { "description": "Fetch a specific AuthorizationDocument.", "tags": [ "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { "fetch": { "value": { "address_sid": "AD11111111111111111111111111111111", "cc_emails": [ "aaa@twilio.com", "bbb@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test@twilio.com", "links": { "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" }, "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "signing", "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchHostedNumbersAuthorizationDocument" }, "post": { "description": "Updates a specific AuthorizationDocument.", "tags": [ "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { "update": { "value": { "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "cc_emails": [ "test1@twilio.com", "test2@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test+hosted@twilio.com", "links": { "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" }, "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "signing", "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "UpdateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateHostedNumbersAuthorizationDocumentRequest", "properties": { "HostedNumberOrderSids": { "type": "array", "items": { "type": "string" }, "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." }, "AddressSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, "Email": { "type": "string", "description": "Email that this AuthorizationDocument will be sent to for signing." }, "CcEmails": { "type": "array", "items": { "type": "string" }, "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" }, "Status": { "type": "string", "$ref": "#/components/schemas/authorization_document_enum_status", "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." }, "ContactTitle": { "type": "string", "description": "The title of the person authorized to sign the Authorization Document for this phone number." }, "ContactPhoneNumber": { "type": "string", "description": "The contact phone number of the person authorized to sign the Authorization Document." } } }, "examples": { "update": { "value": { "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Email": "test+hosted@twilio.com", "CcEmails": [ "test1@twilio.com", "test2@twilio.com" ], "HostedNumberOrderSids": [ "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" ], "Status": "signing", "ContactTitle": "Mr.", "ContactPhoneNumber": "+14155555555" } } } } } } } }, "/HostedNumbers/AuthorizationDocuments": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { "signing_document_sid": "sid" }, "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } }, "pathType": "list" }, "get": { "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", "tags": [ "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { "name": "Email", "in": "query", "description": "Email that this AuthorizationDocument will be sent to for signing.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "examples": { "readEmpty": { "value": "test+hosted@twilio.com" } } }, { "name": "Status", "in": "query", "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", "schema": { "type": "string", "$ref": "#/components/schemas/authorization_document_enum_status" }, "examples": { "readEmpty": { "value": "signed" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.hosted_numbers.authorization_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": "ListHostedNumbersAuthorizationDocumentResponse" }, "examples": { "readEmpty": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" }, "items": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" }, "items": [ { "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "cc_emails": [ "test1@twilio.com", "test2@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test+hosted@twilio.com", "links": { "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" }, "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "signing", "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } } } } }, "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": "ListHostedNumbersAuthorizationDocument" }, "post": { "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", "tags": [ "PreviewHostedNumbersAuthorizationDocument" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { "create": { "value": { "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "cc_emails": [ "test1@twilio.com", "test2@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test+hosted@twilio.com", "links": { "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" }, "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "signing", "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "CreateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateHostedNumbersAuthorizationDocumentRequest", "properties": { "HostedNumberOrderSids": { "type": "array", "items": { "type": "string" }, "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." }, "AddressSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, "Email": { "type": "string", "description": "Email that this AuthorizationDocument will be sent to for signing." }, "ContactTitle": { "type": "string", "description": "The title of the person authorized to sign the Authorization Document for this phone number." }, "ContactPhoneNumber": { "type": "string", "description": "The contact phone number of the person authorized to sign the Authorization Document." }, "CcEmails": { "type": "array", "items": { "type": "string" }, "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." } }, "required": [ "HostedNumberOrderSids", "AddressSid", "Email", "ContactTitle", "ContactPhoneNumber" ] }, "examples": { "create": { "value": { "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Email": "test+hosted@twilio.com", "CcEmails": [ "test1@twilio.com", "test2@twilio.com" ], "HostedNumberOrderSids": [ "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" ], "ContactTitle": "Mr.", "ContactPhoneNumber": "+14155555555" } } } } } } } }, "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/AuthorizationDocuments/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", "tags": [ "PreviewHostedNumbersDependentHostedNumberOrder" ], "parameters": [ { "name": "SigningDocumentSid", "in": "path", "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Status", "in": "query", "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", "schema": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" }, "examples": { "readEmpty": { "value": "completed" } } }, { "name": "PhoneNumber", "in": "query", "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "schema": { "type": "string", "format": "phone-number" }, "examples": { "readEmpty": { "value": "+19193608000" } } }, { "name": "IncomingPhoneNumberSid", "in": "query", "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" }, "examples": { "readEmpty": { "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, { "name": "FriendlyName", "in": "query", "description": "A human readable description of this resource, up to 64 characters.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "examples": { "readEmpty": { "value": "example" } } }, { "name": "UniqueName", "in": "query", "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "examples": { "readEmpty": { "value": "something123" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" } }, "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": "ListHostedNumbersDependentHostedNumberOrderResponse" }, "examples": { "readEmpty": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" }, "items": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" }, "items": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": "AD11111111111111111111111111111111", "call_delay": 15, "capabilities": { "sms": true, "voice": false }, "cc_emails": [ "aaa@twilio.com", "bbb@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test@twilio.com", "extension": "1234", "friendly_name": "friendly_name", "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": "PX11111111111111111111111111111111", "status": "received", "failure_reason": "", "unique_name": "foobar", "verification_attempts": 0, "verification_call_sids": [ "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "verification_code": "8794", "verification_document_sid": null, "verification_type": "phone-call" } ] } } } } }, "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": "ListHostedNumbersDependentHostedNumberOrder" } }, "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance" }, "get": { "description": "Fetch a specific HostedNumberOrder.", "tags": [ "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": "AD11111111111111111111111111111111", "call_delay": 15, "capabilities": { "sms": true, "voice": false }, "cc_emails": [ "aaa@twilio.com", "bbb@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test@twilio.com", "extension": "5105", "failure_reason": "", "friendly_name": "friendly_name", "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": "PX11111111111111111111111111111111", "status": "received", "unique_name": "foobar", "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_attempts": 0, "verification_call_sids": [ "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "verification_code": "8794", "verification_document_sid": null, "verification_type": "phone-call" } } } } }, "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": "FetchHostedNumbersHostedNumberOrder" }, "delete": { "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", "tags": [ "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteHostedNumbersHostedNumberOrder" }, "post": { "description": "Updates a specific HostedNumberOrder.", "tags": [ "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": "AD11111111111111111111111111111111", "call_delay": 15, "capabilities": { "sms": true, "voice": false }, "cc_emails": [ "test1@twilio.com", "test2@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test+hosted@twilio.com", "extension": "1234", "failure_reason": "", "friendly_name": "new friendly name", "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": "PX11111111111111111111111111111111", "status": "pending-loa", "unique_name": "new unique name", "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_attempts": 1, "verification_call_sids": [ "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "verification_code": "8794", "verification_document_sid": null, "verification_type": "phone-call" } } } } }, "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": "UpdateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateHostedNumbersHostedNumberOrderRequest", "properties": { "FriendlyName": { "type": "string", "description": "A 64 character string that is a human readable text that describes this resource." }, "UniqueName": { "type": "string", "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." }, "Email": { "type": "string", "description": "Email of the owner of this phone number that is being hosted." }, "CcEmails": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." }, "Status": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_status", "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." }, "VerificationCode": { "type": "string", "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." }, "VerificationType": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." }, "VerificationDocumentSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." }, "Extension": { "type": "string", "description": "Digits to dial after connecting the verification call." }, "CallDelay": { "type": "integer", "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." } } }, "examples": { "update": { "value": { "FriendlyName": "new friendly name", "UniqueName": "new unique name", "Email": "test+hosted@twilio.com", "CcEmails": [ "test1@twilio.com", "test2@twilio.com" ], "Status": "pending-loa", "Extension": "1234", "CallDelay": 15 } } } } } } } }, "/HostedNumbers/HostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" }, "get": { "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", "tags": [ "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { "name": "Status", "in": "query", "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", "schema": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_status" }, "examples": { "readEmpty": { "value": "completed" } } }, { "name": "PhoneNumber", "in": "query", "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "schema": { "type": "string", "format": "phone-number" }, "examples": { "readEmpty": { "value": "+19193608000" } } }, { "name": "IncomingPhoneNumberSid", "in": "query", "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" }, "examples": { "readEmpty": { "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" } } }, { "name": "FriendlyName", "in": "query", "description": "A human readable description of this resource, up to 64 characters.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "examples": { "readEmpty": { "value": "example" } } }, { "name": "UniqueName", "in": "query", "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "schema": { "type": "string" }, "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } }, "examples": { "readEmpty": { "value": "something123" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.hosted_numbers.hosted_number_order" } }, "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": "ListHostedNumbersHostedNumberOrderResponse" }, "examples": { "readEmpty": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" }, "items": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" }, "items": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": "AD11111111111111111111111111111111", "call_delay": 15, "capabilities": { "sms": true, "voice": false }, "cc_emails": [ "aaa@twilio.com", "bbb@twilio.com" ], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test@twilio.com", "extension": "1234", "failure_reason": "", "friendly_name": "friendly_name", "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": "PX11111111111111111111111111111111", "status": "received", "unique_name": "foobar", "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_attempts": 0, "verification_call_sids": [ "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "verification_code": "8794", "verification_document_sid": null, "verification_type": "phone-call" } ] } } } } }, "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": "ListHostedNumbersHostedNumberOrder" }, "post": { "description": "Host a phone number's capability on Twilio's platform.", "tags": [ "PreviewHostedNumbersHostedNumberOrder" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": "AD11111111111111111111111111111111", "call_delay": 0, "capabilities": { "sms": true, "voice": false }, "cc_emails": [], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": "test@twilio.com", "extension": null, "failure_reason": "", "friendly_name": null, "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": null, "status": "received", "unique_name": null, "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_attempts": 0, "verification_call_sids": null, "verification_code": null, "verification_document_sid": null, "verification_type": "phone-call" } }, "createWithoutOptionalLoaFields": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": null, "call_delay": 0, "capabilities": { "sms": true, "voice": false }, "cc_emails": [], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": null, "extension": null, "failure_reason": "", "friendly_name": null, "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": null, "status": "received", "unique_name": null, "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_attempts": 0, "verification_call_sids": null, "verification_code": null, "verification_document_sid": null, "verification_type": "phone-call" } }, "createWithPhoneBillVerification": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address_sid": null, "call_delay": 0, "capabilities": { "sms": true, "voice": false }, "cc_emails": [], "date_created": "2017-03-28T20:06:39Z", "date_updated": "2017-03-28T20:06:39Z", "email": null, "extension": null, "failure_reason": "", "friendly_name": null, "incoming_phone_number_sid": "PN11111111111111111111111111111111", "phone_number": "+14153608311", "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "signing_document_sid": null, "status": "received", "unique_name": null, "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_attempts": 0, "verification_call_sids": null, "verification_code": null, "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "verification_type": "phone-bill" } } } } }, "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": "CreateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateHostedNumbersHostedNumberOrderRequest", "properties": { "PhoneNumber": { "type": "string", "format": "phone-number", "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" }, "SmsCapability": { "type": "boolean", "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." }, "AccountSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." }, "FriendlyName": { "type": "string", "description": "A 64 character string that is a human readable text that describes this resource." }, "UniqueName": { "type": "string", "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." }, "CcEmails": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." }, "SmsUrl": { "type": "string", "format": "uri", "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." }, "SmsMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." }, "SmsFallbackUrl": { "type": "string", "format": "uri", "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." }, "SmsFallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." }, "StatusCallbackUrl": { "type": "string", "format": "uri", "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." }, "StatusCallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." }, "SmsApplicationSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." }, "AddressSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." }, "Email": { "type": "string", "description": "Optional. Email of the owner of this phone number that is being hosted." }, "VerificationType": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." }, "VerificationDocumentSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." } }, "required": [ "PhoneNumber", "SmsCapability" ] }, "examples": { "create": { "value": { "AddressSid": "AD11111111111111111111111111111111", "PhoneNumber": "+14153608311", "SmsCapability": true, "Email": "test@twilio.com" } }, "createWithoutOptionalLoaFields": { "value": { "PhoneNumber": "+14153608311", "SmsCapability": true } }, "createWithPhoneBillVerification": { "value": { "PhoneNumber": "+14153608311", "SmsCapability": true, "VerificationType": "phone-bill", "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } } } }, "/marketplace/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "available_add_on_sid": "sid" }, "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } }, "pathType": "instance" }, "get": { "description": "Fetch an instance of an Add-on currently available to be installed.", "tags": [ "PreviewMarketplaceAvailableAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the AvailableAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.available_add_on" }, "examples": { "fetch": { "value": { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "pricing_type": "per minute", "configuration_schema": { "type": "object", "properties": { "bad_words": { "type": "boolean" } }, "required": [ "bad_words" ] }, "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" } } } } } }, "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": "FetchMarketplaceAvailableAddOn" } }, "/marketplace/AvailableAddOns": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "available_add_on_sid": "sid" }, "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } }, "pathType": "list" }, "get": { "description": "Retrieve a list of Add-ons currently available to be installed.", "tags": [ "PreviewMarketplaceAvailableAddOn" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "available_add_ons": { "type": "array", "items": { "$ref": "#/components/schemas/preview.marketplace.available_add_on" } }, "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": "ListMarketplaceAvailableAddOnResponse" }, "examples": { "readFull": { "value": { "available_add_ons": [ { "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "pricing_type": "per minute", "configuration_schema": { "type": "object", "properties": { "bad_words": { "type": "boolean" } }, "required": [ "bad_words" ] }, "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "available_add_ons" } } }, "readEmpty": { "value": { "available_add_ons": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "available_add_ons" } } } } } }, "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": "ListMarketplaceAvailableAddOn" } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/AvailableAddOns/{Sid}", "className": "available_add_on_extension", "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Available Add-on.", "tags": [ "PreviewMarketplaceAvailableAddOnExtension" ], "parameters": [ { "name": "AvailableAddOnSid", "in": "path", "description": "The SID of the AvailableAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the AvailableAddOn Extension resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" }, "examples": { "fetch": { "value": { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchMarketplaceAvailableAddOnExtension" } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/AvailableAddOns/{Sid}", "className": "available_add_on_extension", "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Available Add-on.", "tags": [ "PreviewMarketplaceAvailableAddOnExtension" ], "parameters": [ { "name": "AvailableAddOnSid", "in": "path", "description": "The SID of the AvailableAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" } }, "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": "ListMarketplaceAvailableAddOnExtensionResponse" }, "examples": { "readFull": { "value": { "extensions": [ { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } }, "readEmpty": { "value": { "extensions": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } } } } }, "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": "ListMarketplaceAvailableAddOnExtension" } }, "/marketplace/InstalledAddOns": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" }, "usage": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } }, "pathType": "list" }, "post": { "description": "Install an Add-on for the Account specified.", "tags": [ "PreviewMarketplaceInstalledAddOn" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { "create": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription_1", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } }, "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": "CreateMarketplaceInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateMarketplaceInstalledAddOnRequest", "properties": { "AvailableAddOnSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "description": "The SID of the AvaliableAddOn to install." }, "AcceptTermsOfService": { "type": "boolean", "description": "Whether the Terms of Service were accepted." }, "Configuration": { "description": "The JSON object that represents the configuration of the new Add-on being installed." }, "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } }, "required": [ "AvailableAddOnSid", "AcceptTermsOfService" ] }, "examples": { "create": { "value": { "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "AcceptTermsOfService": true, "Configuration": "{\"bad_words\": true}", "UniqueName": "voicebase_high_accuracy_transcription_1" } } } } } } }, "get": { "description": "Retrieve a list of Add-ons currently installed on this Account.", "tags": [ "PreviewMarketplaceInstalledAddOn" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "installed_add_ons": { "type": "array", "items": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } }, "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": "ListMarketplaceInstalledAddOnResponse" }, "examples": { "readFull": { "value": { "installed_add_ons": [ { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "installed_add_ons" } } }, "readEmpty": { "value": { "installed_add_ons": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "next_page_url": null, "key": "installed_add_ons" } } } } } }, "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": "ListMarketplaceInstalledAddOn" } }, "/marketplace/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "extensions": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" }, "usage": { "mapping": { "installed_add_on_sid": "sid" }, "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } }, "pathType": "instance" }, "delete": { "description": "Remove an Add-on installation from your account", "tags": [ "PreviewMarketplaceInstalledAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteMarketplaceInstalledAddOn" }, "get": { "description": "Fetch an instance of an Add-on currently installed on this Account.", "tags": [ "PreviewMarketplaceInstalledAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { "fetch": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } }, "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": "FetchMarketplaceInstalledAddOn" }, "post": { "description": "Update an Add-on installation for the Account specified.", "tags": [ "PreviewMarketplaceInstalledAddOn" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { "update": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "VoiceBase High Accuracy Transcription", "description": "Automatic Transcription and Keyword Extract...", "configuration": { "bad_words": true }, "unique_name": "voicebase_high_accuracy_transcription_2", "date_created": "2016-04-07T23:52:28Z", "date_updated": "2016-04-07T23:52:28Z", "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } }, "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": "UpdateMarketplaceInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateMarketplaceInstalledAddOnRequest", "properties": { "Configuration": { "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" }, "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } } }, "examples": { "update": { "value": { "Configuration": "{\"bad_words\": true}", "UniqueName": "voicebase_high_accuracy_transcription_2" } } } } } } } }, "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_extension", "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Installed Add-on.", "tags": [ "PreviewMarketplaceInstalledAddOnExtension" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "The SID of the InstalledAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn Extension resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" }, "examples": { "fetch": { "value": { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "enabled": true, "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchMarketplaceInstalledAddOnExtension" }, "post": { "description": "Update an Extension for an Add-on installation.", "tags": [ "PreviewMarketplaceInstalledAddOnExtension" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "The SID of the InstalledAddOn resource with the extension to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the InstalledAddOn Extension resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" }, "examples": { "update": { "value": { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "enabled": false, "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "UpdateMarketplaceInstalledAddOnExtension", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", "properties": { "Enabled": { "type": "boolean", "description": "Whether the Extension should be invoked." } }, "required": [ "Enabled" ] }, "examples": { "update": { "value": { "Enabled": false } } } } } } } }, "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_extension", "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Installed Add-on.", "tags": [ "PreviewMarketplaceInstalledAddOnExtension" ], "parameters": [ { "name": "InstalledAddOnSid", "in": "path", "description": "The SID of the InstalledAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } }, "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": "ListMarketplaceInstalledAddOnExtensionResponse" }, "examples": { "readFull": { "value": { "extensions": [ { "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Incoming Voice Call", "product_name": "Programmable Voice", "unique_name": "voice-incoming", "enabled": true, "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } }, "readEmpty": { "value": { "extensions": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "next_page_url": null, "key": "extensions" } } } } } }, "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": "ListMarketplaceInstalledAddOnExtension" } }, "/Sync/Services/{ServiceSid}/Documents/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "permissions": { "mapping": { "service_sid": "service_sid", "document_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewSyncDocument" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://preview.twilio.com/Sync/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": "FetchSyncDocument" }, "delete": { "description": "", "tags": [ "PreviewSyncDocument" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncDocument" }, "post": { "description": "", "tags": [ "PreviewSyncDocument" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "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/preview.sync.service.document" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://preview.twilio.com/Sync/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": "UpdateSyncDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncDocumentRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] }, "examples": { "update": { "value": { "Data": "{}", "UniqueName": "unique_name" } } } } } } } }, "/Sync/Services/{ServiceSid}/Documents": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "permissions": { "mapping": { "service_sid": "service_sid", "document_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "post": { "description": "", "tags": [ "PreviewSyncDocument" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://preview.twilio.com/Sync/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": "CreateSyncDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncDocumentRequest", "properties": { "UniqueName": { "type": "string", "description": "" }, "Data": { "description": "" } } }, "examples": { "create": { "value": { "Data": "{}", "UniqueName": "unique_name" } } } } } } }, "get": { "description": "", "tags": [ "PreviewSyncDocument" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncDocumentResponse" }, "examples": { "readEmpty": { "value": { "documents": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", "key": "documents", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } }, "readFull": { "value": { "documents": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" } } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", "key": "documents", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/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": "ListSyncDocument" } }, "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Documents/{Sid}", "mountName": "document_permissions", "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Document Permission.", "tags": [ "PreviewSyncDocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/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": "FetchSyncDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", "tags": [ "PreviewSyncDocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", "tags": [ "PreviewSyncDocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The unique SID identifier of the Sync Service Instance.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/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": "UpdateSyncDocumentPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncDocumentPermissionRequest", "properties": { "Read": { "type": "boolean", "description": "Boolean flag specifying whether the identity can read the Sync Document." }, "Write": { "type": "boolean", "description": "Boolean flag specifying whether the identity can update the Sync Document." }, "Manage": { "type": "boolean", "description": "Boolean flag specifying whether the identity can delete the Sync Document." } }, "required": [ "Read", "Write", "Manage" ] }, "examples": { "update": { "value": { "Read": "true", "Write": "true", "Manage": "true" } } } } } } } }, "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Documents/{Sid}", "mountName": "document_permissions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Document.", "tags": [ "PreviewSyncDocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "DocumentSid", "in": "path", "description": "Identifier of the Sync Document. Either a SID or a 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 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncDocumentPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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": "ListSyncDocumentPermission" } }, "/Sync/Services/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "documents": { "mapping": { "service_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Documents" }, "lists": { "mapping": { "service_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Lists" }, "maps": { "mapping": { "service_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Maps" } }, "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewSyncService" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "reachability_webhooks_enabled": false, "acl_enabled": false } } } } }, "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": "FetchSyncService" }, "delete": { "description": "", "tags": [ "PreviewSyncService" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncService" }, "post": { "description": "", "tags": [ "PreviewSyncService" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "reachability_webhooks_enabled": false, "acl_enabled": true } } } } }, "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": "UpdateSyncService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncServiceRequest", "properties": { "WebhookUrl": { "type": "string", "format": "uri", "description": "" }, "FriendlyName": { "type": "string", "description": "" }, "ReachabilityWebhooksEnabled": { "type": "boolean", "description": "" }, "AclEnabled": { "type": "boolean", "description": "" } } }, "examples": { "update": { "value": { "FriendlyName": "friendly_name", "WebhookUrl": "http://www.example.com", "AclEnabled": true } } } } } } } }, "/Sync/Services": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "documents": { "mapping": { "service_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Documents" }, "lists": { "mapping": { "service_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Lists" }, "maps": { "mapping": { "service_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Maps" } }, "pathType": "list" }, "post": { "description": "", "tags": [ "PreviewSyncService" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "reachability_webhooks_enabled": false, "acl_enabled": true } } } } }, "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": "CreateSyncService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncServiceRequest", "properties": { "FriendlyName": { "type": "string", "description": "" }, "WebhookUrl": { "type": "string", "format": "uri", "description": "" }, "ReachabilityWebhooksEnabled": { "type": "boolean", "description": "" }, "AclEnabled": { "type": "boolean", "description": "" } } }, "examples": { "create": { "value": { "FriendlyName": "friendly_name", "WebhookUrl": "http://www.example.com", "AclEnabled": true } } } } } } }, "get": { "description": "", "tags": [ "PreviewSyncService" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncServiceResponse" }, "examples": { "readEmpty": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" }, "services": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_url": "http://www.example.com", "reachability_webhooks_enabled": false, "acl_enabled": false } ] } } } } }, "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": "ListSyncService" } }, "/Sync/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_lists", "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewSyncSyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://preview.twilio.com/Sync/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": "FetchSyncSyncList" }, "delete": { "description": "", "tags": [ "PreviewSyncSyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncSyncList" } }, "/Sync/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "list_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_lists", "pathType": "list" }, "post": { "description": "", "tags": [ "PreviewSyncSyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://preview.twilio.com/Sync/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": "CreateSyncSyncList", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncListRequest", "properties": { "UniqueName": { "type": "string", "description": "" } } }, "examples": { "create": { "value": { "UniqueName": "unique_name" } } } } } } }, "get": { "description": "", "tags": [ "PreviewSyncSyncList" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncSyncListResponse" }, "examples": { "readEmpty": { "value": { "lists": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", "key": "lists", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } }, "readFull": { "value": { "lists": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", "key": "lists", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/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": "ListSyncSyncList" } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_items", "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewSyncSyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Index", "in": "path", "description": "", "schema": { "type": "integer" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/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": "FetchSyncSyncListItem" }, "delete": { "description": "", "tags": [ "PreviewSyncSyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Index", "in": "path", "description": "", "schema": { "type": "integer" }, "required": true }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP request header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncSyncListItem" }, "post": { "description": "", "tags": [ "PreviewSyncSyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Index", "in": "path", "description": "", "schema": { "type": "integer" }, "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/preview.sync.service.sync_list.sync_list_item" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/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": "UpdateSyncSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncSyncListItemRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] }, "examples": { "update": { "value": { "Data": "{}" } } } } } } } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_items", "pathType": "list" }, "post": { "description": "", "tags": [ "PreviewSyncSyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/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": "CreateSyncSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncListItemRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] }, "examples": { "create": { "value": { "Data": "{}" } } } } } } }, "get": { "description": "", "tags": [ "PreviewSyncSyncListItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Order", "in": "query", "description": "", "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" }, "examples": { "readEmpty": { "value": "asc" }, "readFull": { "value": "asc" } } }, { "name": "From", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "from" }, "readFull": { "value": "from" } } }, { "name": "Bounds", "in": "query", "description": "", "schema": { "type": "string", "$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 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncSyncListItemResponse" }, "examples": { "readEmpty": { "value": { "items": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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_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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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": "ListSyncSyncListItem" } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_permissions", "pathType": "instance" }, "get": { "description": "Fetch a specific Sync List Permission.", "tags": [ "PreviewSyncSyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/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": "FetchSyncSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", "tags": [ "PreviewSyncSyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", "tags": [ "PreviewSyncSyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The unique SID identifier of the Sync Service Instance.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/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": "UpdateSyncSyncListPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncSyncListPermissionRequest", "properties": { "Read": { "type": "boolean", "description": "Boolean flag specifying whether the identity can read the Sync List." }, "Write": { "type": "boolean", "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, "Manage": { "type": "boolean", "description": "Boolean flag specifying whether the identity can delete the Sync List." } }, "required": [ "Read", "Write", "Manage" ] }, "examples": { "update": { "value": { "Read": "true", "Write": "true", "Manage": "true" } } } } } } } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_permissions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync List.", "tags": [ "PreviewSyncSyncListPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ListSid", "in": "path", "description": "Identifier of the Sync List. Either a SID or a 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 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncSyncListPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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": "ListSyncSyncListPermission" } }, "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_maps", "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewSyncSyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://preview.twilio.com/Sync/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": "FetchSyncSyncMap" }, "delete": { "description": "", "tags": [ "PreviewSyncSyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncSyncMap" } }, "/Sync/Services/{ServiceSid}/Maps": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "items": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", "map_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" } }, "parent": "/Services/{Sid}", "mountName": "sync_maps", "pathType": "list" }, "post": { "description": "", "tags": [ "PreviewSyncSyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://preview.twilio.com/Sync/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": "CreateSyncSyncMap", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncMapRequest", "properties": { "UniqueName": { "type": "string", "description": "" } } }, "examples": { "create": { "value": { "UniqueName": "unique_name" } } } } } } }, "get": { "description": "", "tags": [ "PreviewSyncSyncMap" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncSyncMapResponse" }, "examples": { "readEmpty": { "value": { "maps": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", "key": "maps", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } }, "readFull": { "value": { "maps": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", "key": "maps", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/Sync/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": "ListSyncSyncMap" } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_items", "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewSyncSyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/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": "FetchSyncSyncMapItem" }, "delete": { "description": "", "tags": [ "PreviewSyncSyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP request header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncSyncMapItem" }, "post": { "description": "", "tags": [ "PreviewSyncSyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "", "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/preview.sync.service.sync_map.sync_map_item" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/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": "UpdateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncSyncMapItemRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] }, "examples": { "update": { "value": { "Data": "{}" } } } } } } } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_items", "pathType": "list" }, "post": { "description": "", "tags": [ "PreviewSyncSyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "data": {}, "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://preview.twilio.com/Sync/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": "CreateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncMapItemRequest", "properties": { "Key": { "type": "string", "description": "" }, "Data": { "description": "" } }, "required": [ "Key", "Data" ] }, "examples": { "create": { "value": { "Data": "{}", "Key": "key" } } } } } } }, "get": { "description": "", "tags": [ "PreviewSyncSyncMapItem" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Order", "in": "query", "description": "", "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" }, "examples": { "readEmpty": { "value": "asc" }, "readFull": { "value": "asc" } } }, { "name": "From", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "from" }, "readFull": { "value": "from" } } }, { "name": "Bounds", "in": "query", "description": "", "schema": { "type": "string", "$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 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncSyncMapItemResponse" }, "examples": { "readEmpty": { "value": { "items": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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_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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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": "ListSyncSyncMapItem" } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_permissions", "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Map Permission.", "tags": [ "PreviewSyncSyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/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": "FetchSyncSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", "tags": [ "PreviewSyncSyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteSyncSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", "tags": [ "PreviewSyncSyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The unique SID identifier of the Sync Service Instance.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "path", "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.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://preview.twilio.com/Sync/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": "UpdateSyncSyncMapPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncSyncMapPermissionRequest", "properties": { "Read": { "type": "boolean", "description": "Boolean flag specifying whether the identity can read the Sync Map." }, "Write": { "type": "boolean", "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, "Manage": { "type": "boolean", "description": "Boolean flag specifying whether the identity can delete the Sync Map." } }, "required": [ "Read", "Write", "Manage" ] }, "examples": { "update": { "value": { "Read": "true", "Write": "true", "Manage": "true" } } } } } } } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_permissions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Map.", "tags": [ "PreviewSyncSyncMapPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "MapSid", "in": "path", "description": "Identifier of the Sync Map. Either a SID or a 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 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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/preview.sync.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": "ListSyncSyncMapPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { "first_page_url": "https://preview.twilio.com/Sync/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://preview.twilio.com/Sync/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": "ListSyncSyncMapPermission" } }, "/wireless/Commands/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewWirelessCommand" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DC[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.command" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "command": "command", "command_mode": "command_mode", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "direction": "direction", "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "status", "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchWirelessCommand" } }, "/wireless/Commands": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" }, "get": { "description": "", "tags": [ "PreviewWirelessCommand" ], "parameters": [ { "name": "Device", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "device" }, "readFull": { "value": "device" } } }, { "name": "Sim", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "sim" }, "readFull": { "value": "sim" } } }, { "name": "Status", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "status" }, "readFull": { "value": "status" } } }, { "name": "Direction", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "direction" }, "readFull": { "value": "direction" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/preview.wireless.command" } }, "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": "ListWirelessCommandResponse" }, "examples": { "readEmpty": { "value": { "commands": [], "meta": { "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", "key": "commands", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" } } }, "readFull": { "value": { "commands": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "command": "command", "command_mode": "command_mode", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "direction": "direction", "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "status", "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", "key": "commands", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&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": "ListWirelessCommand" }, "post": { "description": "", "tags": [ "PreviewWirelessCommand" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.command" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "command": "command", "command_mode": "command_mode", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "direction": "direction", "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "status", "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "CreateWirelessCommand", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateWirelessCommandRequest", "properties": { "Command": { "type": "string", "description": "" }, "Device": { "type": "string", "description": "" }, "Sim": { "type": "string", "description": "" }, "CallbackMethod": { "type": "string", "description": "" }, "CallbackUrl": { "type": "string", "format": "uri", "description": "" }, "CommandMode": { "type": "string", "description": "" }, "IncludeSid": { "type": "string", "description": "" } }, "required": [ "Command" ] }, "examples": { "create": { "value": { "CallbackMethod": "callback_method", "CallbackUrl": "http://www.example.com", "Command": "command", "CommandMode": "command_mode", "Device": "device", "Sim": "sim", "IncludeSid": "include_sid" } } } } } } } }, "/wireless/RatePlans": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" }, "get": { "description": "", "tags": [ "PreviewWirelessRatePlan" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "rate_plans": { "type": "array", "items": { "$ref": "#/components/schemas/preview.wireless.rate_plan" } }, "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": "ListWirelessRatePlanResponse" }, "examples": { "readEmpty": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", "key": "rate_plans", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" }, "rate_plans": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", "key": "rate_plans", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" }, "rate_plans": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "data_enabled": true, "data_limit": 1000, "data_metering": "pooled", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "messaging_enabled": true, "voice_enabled": true, "national_roaming_enabled": true, "international_roaming": [ "data", "messaging", "voice" ], "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } } } } }, "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": "ListWirelessRatePlan" }, "post": { "description": "", "tags": [ "PreviewWirelessRatePlan" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.rate_plan" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "data_enabled": true, "data_limit": 1000, "data_metering": "pooled", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "messaging_enabled": true, "voice_enabled": true, "national_roaming_enabled": true, "international_roaming": [ "data", "messaging", "voice" ], "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "CreateWirelessRatePlan", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateWirelessRatePlanRequest", "properties": { "UniqueName": { "type": "string", "description": "" }, "FriendlyName": { "type": "string", "description": "" }, "DataEnabled": { "type": "boolean", "description": "" }, "DataLimit": { "type": "integer", "description": "" }, "DataMetering": { "type": "string", "description": "" }, "MessagingEnabled": { "type": "boolean", "description": "" }, "VoiceEnabled": { "type": "boolean", "description": "" }, "CommandsEnabled": { "type": "boolean", "description": "" }, "NationalRoamingEnabled": { "type": "boolean", "description": "" }, "InternationalRoaming": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "examples": { "create": { "value": { "UniqueName": "unique_name", "DataEnabled": true, "DataLimit": 1000, "DataMetering": "pooled", "MessagingEnabled": true, "VoiceEnabled": true, "FriendlyName": "friendly_name", "NationalRoamingEnabled": true, "InternationalRoaming": [ "data", "voice", "messaging" ], "Status": "status" } } } } } } } }, "/wireless/RatePlans/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewWirelessRatePlan" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.rate_plan" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "data_enabled": true, "data_limit": 1000, "data_metering": "pooled", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "messaging_enabled": true, "voice_enabled": true, "national_roaming_enabled": true, "international_roaming": [ "data", "messaging", "voice" ], "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchWirelessRatePlan" }, "post": { "description": "", "tags": [ "PreviewWirelessRatePlan" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.rate_plan" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "data_enabled": true, "data_limit": 1000, "data_metering": "pooled", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "messaging_enabled": true, "voice_enabled": true, "national_roaming_enabled": true, "international_roaming": [ "data", "messaging", "voice" ], "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "UpdateWirelessRatePlan", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateWirelessRatePlanRequest", "properties": { "UniqueName": { "type": "string", "description": "" }, "FriendlyName": { "type": "string", "description": "" } } }, "examples": { "update": { "value": { "UniqueName": "unique_name", "FriendlyName": "friendly_name" } } } } } } }, "delete": { "description": "", "tags": [ "PreviewWirelessRatePlan" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteWirelessRatePlan" } }, "/wireless/Sims/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "usage": { "mapping": { "sim_sid": "sid" }, "resource_url": "/wireless/Sims/{sim_sid}/Usage" } }, "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewWirelessSim" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.sim" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "commands_callback_method": "http_method", "commands_callback_url": "http://www.example.com", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "sms_fallback_method": "http_method", "sms_fallback_url": "http://www.example.com", "sms_method": "http_method", "sms_url": "http://www.example.com", "voice_fallback_method": "http_method", "voice_fallback_url": "http://www.example.com", "voice_method": "http_method", "voice_url": "http://www.example.com", "links": { "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "iccid": "iccid", "e_id": "e_id", "status": "status", "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchWirelessSim" }, "post": { "description": "", "tags": [ "PreviewWirelessSim" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.sim" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "commands_callback_method": "http_method", "commands_callback_url": "http://www.example.com", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "links": { "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "iccid": "iccid", "e_id": "e_id", "status": "status", "sms_fallback_method": "http_method", "sms_fallback_url": "http://www.example.com", "sms_method": "http_method", "sms_url": "http://www.example.com", "voice_fallback_method": "http_method", "voice_fallback_url": "http://www.example.com", "voice_method": "http_method", "voice_url": "http://www.example.com", "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "UpdateWirelessSim", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateWirelessSimRequest", "properties": { "UniqueName": { "type": "string", "description": "" }, "CallbackMethod": { "type": "string", "description": "" }, "CallbackUrl": { "type": "string", "format": "uri", "description": "" }, "FriendlyName": { "type": "string", "description": "" }, "RatePlan": { "type": "string", "description": "" }, "Status": { "type": "string", "description": "" }, "CommandsCallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "CommandsCallbackUrl": { "type": "string", "format": "uri", "description": "" }, "SmsFallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "SmsFallbackUrl": { "type": "string", "format": "uri", "description": "" }, "SmsMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "SmsUrl": { "type": "string", "format": "uri", "description": "" }, "VoiceFallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "VoiceFallbackUrl": { "type": "string", "format": "uri", "description": "" }, "VoiceMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "VoiceUrl": { "type": "string", "format": "uri", "description": "" } } }, "examples": { "update": { "value": { "UniqueName": "unique_name", "CallbackMethod": "callback_method", "CallbackUrl": "http://www.example.com", "CommandsCallbackMethod": "http_method", "CommandsCallbackUrl": "http://www.example.com", "VoiceMethod": "http_method", "VoiceUrl": "http://www.example.com", "VoiceFallbackMethod": "http_method", "VoiceFallbackUrl": "http://www.example.com", "SmsMethod": "http_method", "SmsUrl": "http://www.example.com", "SmsFallbackMethod": "http_method", "SmsFallbackUrl": "http://www.example.com", "FriendlyName": "friendly_name", "RatePlan": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Status": "status" } } } } } } } }, "/wireless/Sims": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { "usage": { "mapping": { "sim_sid": "sid" }, "resource_url": "/wireless/Sims/{sim_sid}/Usage" } }, "pathType": "list" }, "get": { "description": "", "tags": [ "PreviewWirelessSim" ], "parameters": [ { "name": "Status", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "status" }, "readFull": { "value": "status" } } }, { "name": "Iccid", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "iccid" }, "readFull": { "value": "iccid" } } }, { "name": "RatePlan", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "readEmpty": { "value": "rate_plan" }, "readFull": { "value": "rate_plan" } } }, { "name": "EId", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "SimRegistrationCode", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "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": { "sims": { "type": "array", "items": { "$ref": "#/components/schemas/preview.wireless.sim" } }, "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": "ListWirelessSimResponse" }, "examples": { "readEmpty": { "value": { "sims": [], "meta": { "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", "key": "sims", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" } } }, "readFull": { "value": { "sims": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", "commands_callback_method": "http_method", "commands_callback_url": "http://www.example.com", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", "links": { "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "iccid": "iccid", "e_id": "e_id", "status": "status", "sms_fallback_method": "http_method", "sms_fallback_url": "http://www.example.com", "sms_method": "http_method", "sms_url": "http://www.example.com", "voice_fallback_method": "http_method", "voice_fallback_url": "http://www.example.com", "voice_method": "http_method", "voice_url": "http://www.example.com", "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", "key": "sims", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&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": "ListWirelessSim" } }, "/wireless/Sims/{SimSid}/Usage": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Sims/{Sid}", "pathType": "instance" }, "get": { "description": "", "tags": [ "PreviewWirelessUsage" ], "parameters": [ { "name": "SimSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "End", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "fetch": { "value": "end" } } }, { "name": "Start", "in": "query", "description": "", "schema": { "type": "string" }, "examples": { "fetch": { "value": "start" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.sim.usage" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "commands_costs": {}, "commands_usage": {}, "data_costs": {}, "data_usage": {}, "sim_unique_name": "sim_unique_name", "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "period": {}, "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage" } } } } }, "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": "FetchWirelessUsage" } } }, "servers": [ { "url": "https://preview.twilio.com" } ], "tags": [ { "name": "PreviewHostedNumbersAuthorizationDocument" }, { "name": "PreviewHostedNumbersDependentHostedNumberOrder" }, { "name": "PreviewHostedNumbersHostedNumberOrder" } ], "security": [ { "accountSid_authToken": [] } ] }