{ "components": { "schemas": { "preview.deployed_devices.fleet.certificate": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CY[0-9a-fA-F]{32}$", "nullable": true, "description": "Contains a 34 character string that uniquely identifies this Certificate credential resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Certificate credential resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "Contains a human readable descriptive text for this Certificate credential, up to 256 characters long." }, "fleet_sid": { "type": "string", "nullable": true, "description": "Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of the Account responsible for this Certificate credential." }, "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential." }, "thumbprint": { "type": "string", "nullable": true, "description": "Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format." } } }, "preview.deployed_devices.fleet.deployment": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, "description": "Contains a 34 character string that uniquely identifies this Deployment resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Deployment resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "Contains a human readable descriptive text for this Deployment, up to 64 characters long" }, "fleet_sid": { "type": "string", "nullable": true, "description": "Specifies the unique string identifier of the Fleet that the given Deployment belongs to." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of the Account responsible for this Deployment." }, "sync_service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Deployment was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Deployment was last updated, given in UTC ISO 8601 format." } } }, "preview.deployed_devices.fleet.device": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, "description": "Contains a 34 character string that uniquely identifies this Device resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Device resource." }, "unique_name": { "type": "string", "nullable": true, "description": "Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long." }, "friendly_name": { "type": "string", "nullable": true, "description": "Contains a human readable descriptive text for this Device, up to 256 characters long" }, "fleet_sid": { "type": "string", "nullable": true, "description": "Specifies the unique string identifier of the Fleet that the given Device belongs to." }, "enabled": { "type": "boolean", "nullable": true, "description": "Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of the Account responsible for this Device." }, "identity": { "type": "string", "nullable": true, "description": "Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long." }, "deployment_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of the Deployment group that this Device is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Device was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Device was last updated, given in UTC ISO 8601 format." }, "date_authenticated": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Device was last authenticated, given in UTC ISO 8601 format." } } }, "preview.deployed_devices.fleet": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, "description": "Contains a 34 character string that uniquely identifies this Fleet resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Fleet resource." }, "unique_name": { "type": "string", "nullable": true, "description": "Contains a unique and addressable name of this Fleet, e.g. 'default', up to 128 characters long." }, "friendly_name": { "type": "string", "nullable": true, "description": "Contains a human readable descriptive text for this Fleet, up to 256 characters long." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "Speicifies the unique string identifier of the Account responsible for this Fleet." }, "default_deployment_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, "description": "Contains the string identifier of the automatically provisioned default Deployment of this Fleet." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Fleet was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Fleet was last updated, given in UTC ISO 8601 format." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "Contains a dictionary of URL links to nested resources of this Fleet." } } }, "preview.deployed_devices.fleet.key": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KY[0-9a-fA-F]{32}$", "nullable": true, "description": "Contains a 34 character string that uniquely identifies this Key credential resource." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "Contains an absolute URL for this Key credential resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "Contains a human readable descriptive text for this Key credential, up to 256 characters long." }, "fleet_sid": { "type": "string", "nullable": true, "description": "Specifies the unique string identifier of the Fleet that the given Key credential belongs to." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of the Account responsible for this Key credential." }, "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, "description": "Specifies the unique string identifier of a Device authenticated with this Key credential." }, "secret": { "type": "string", "nullable": true, "description": "Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Key credential was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "Specifies the date this Key credential was last updated, given in UTC ISO 8601 format." } } }, "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", "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", "nullable": true, "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", "nullable": true, "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", "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", "nullable": true, "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", "nullable": true, "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", "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 }, "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", "nullable": true }, "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 } } } }, "securitySchemes": { "accountSid_authToken": { "type": "http", "scheme": "basic" } } }, "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.56.0" }, "openapi": "3.0.1", "paths": { "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Fleets/{Sid}" }, "get": { "description": "Fetch information about a specific Certificate credential in the Fleet.", "tags": [ "PreviewDeployedDevicesCertificate" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeployedDevicesCertificate", "x-maturity": [ "Preview" ] }, "delete": { "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "tags": [ "PreviewDeployedDevicesCertificate" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeployedDevicesCertificate", "x-maturity": [ "Preview" ] }, "post": { "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", "tags": [ "PreviewDeployedDevicesCertificate" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeployedDevicesCertificate", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeployedDevicesCertificateRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." }, "DeviceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/DeployedDevices/Fleets/{FleetSid}/Certificates": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Fleets/{Sid}" }, "post": { "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", "tags": [ "PreviewDeployedDevicesCertificate" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeployedDevicesCertificate", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeployedDevicesCertificateRequest", "properties": { "CertificateData": { "type": "string", "description": "Provides a URL encoded representation of the public certificate in PEM format." }, "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." }, "DeviceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." } }, "required": [ "CertificateData" ] } } } } }, "get": { "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", "tags": [ "PreviewDeployedDevicesCertificate" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "DeviceSid", "in": "query", "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$" } }, { "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": { "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListDeployedDevicesCertificateResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeployedDevicesCertificate", "x-maturity": [ "Preview" ] } }, "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Fleets/{Sid}" }, "get": { "description": "Fetch information about a specific Deployment in the Fleet.", "tags": [ "PreviewDeployedDevicesDeployment" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeployedDevicesDeployment", "x-maturity": [ "Preview" ] }, "delete": { "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", "tags": [ "PreviewDeployedDevicesDeployment" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeployedDevicesDeployment", "x-maturity": [ "Preview" ] }, "post": { "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", "tags": [ "PreviewDeployedDevicesDeployment" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeployedDevicesDeployment", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeployedDevicesDeploymentRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" }, "SyncServiceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/DeployedDevices/Fleets/{FleetSid}/Deployments": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Fleets/{Sid}" }, "post": { "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", "tags": [ "PreviewDeployedDevicesDeployment" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeployedDevicesDeployment", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeployedDevicesDeploymentRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." }, "SyncServiceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "get": { "description": "Retrieve a list of all Deployments belonging to the Fleet.", "tags": [ "PreviewDeployedDevicesDeployment" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "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": { "deployments": { "type": "array", "items": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListDeployedDevicesDeploymentResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeployedDevicesDeployment", "x-maturity": [ "Preview" ] } }, "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Fleets/{Sid}" }, "get": { "description": "Fetch information about a specific Device in the Fleet.", "tags": [ "PreviewDeployedDevicesDevice" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeployedDevicesDevice", "x-maturity": [ "Preview" ] }, "delete": { "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", "tags": [ "PreviewDeployedDevicesDevice" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeployedDevicesDevice", "x-maturity": [ "Preview" ] }, "post": { "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", "tags": [ "PreviewDeployedDevicesDevice" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeployedDevicesDevice", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeployedDevicesDeviceRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." }, "Identity": { "type": "string", "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." }, "DeploymentSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." }, "Enabled": { "type": "boolean", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/DeployedDevices/Fleets/{FleetSid}/Devices": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Fleets/{Sid}" }, "post": { "description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", "tags": [ "PreviewDeployedDevicesDevice" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeployedDevicesDevice", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeployedDevicesDeviceRequest", "properties": { "UniqueName": { "type": "string", "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." }, "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." }, "Identity": { "type": "string", "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." }, "DeploymentSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." }, "Enabled": { "type": "boolean", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "get": { "description": "Retrieve a list of all Devices belonging to the Fleet.", "tags": [ "PreviewDeployedDevicesDevice" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "DeploymentSid", "in": "query", "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$" } }, { "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": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListDeployedDevicesDeviceResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeployedDevicesDevice", "x-maturity": [ "Preview" ] } }, "/DeployedDevices/Fleets/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "dependentProperties": { "devices": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" }, "deployments": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" }, "certificates": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" }, "keys": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } } }, "get": { "description": "Fetch information about a specific Fleet in your account.", "tags": [ "PreviewDeployedDevicesFleet" ], "parameters": [ { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeployedDevicesFleet", "x-maturity": [ "Preview" ] }, "delete": { "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", "tags": [ "PreviewDeployedDevicesFleet" ], "parameters": [ { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeployedDevicesFleet", "x-maturity": [ "Preview" ] }, "post": { "description": "Update the friendly name property of a specific Fleet in your account.", "tags": [ "PreviewDeployedDevicesFleet" ], "parameters": [ { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeployedDevicesFleet", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeployedDevicesFleetRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." }, "DefaultDeploymentSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/DeployedDevices/Fleets": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "dependentProperties": { "devices": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" }, "deployments": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" }, "certificates": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" }, "keys": { "mapping": { "fleet_sid": "sid" }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } } }, "post": { "description": "Create a new Fleet for scoping of deployed devices within your account.", "tags": [ "PreviewDeployedDevicesFleet" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeployedDevicesFleet", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeployedDevicesFleetRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "get": { "description": "Retrieve a list of all Fleets belonging to your account.", "tags": [ "PreviewDeployedDevicesFleet" ], "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": { "fleets": { "type": "array", "items": { "$ref": "#/components/schemas/preview.deployed_devices.fleet" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListDeployedDevicesFleetResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeployedDevicesFleet", "x-maturity": [ "Preview" ] } }, "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Fleets/{Sid}" }, "get": { "description": "Fetch information about a specific Key credential in the Fleet.", "tags": [ "PreviewDeployedDevicesKey" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeployedDevicesKey", "x-maturity": [ "Preview" ] }, "delete": { "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "tags": [ "PreviewDeployedDevicesKey" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeployedDevicesKey", "x-maturity": [ "Preview" ] }, "post": { "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", "tags": [ "PreviewDeployedDevicesKey" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeployedDevicesKey", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeployedDevicesKeyRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." }, "DeviceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/DeployedDevices/Fleets/{FleetSid}/Keys": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Fleets/{Sid}" }, "post": { "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", "tags": [ "PreviewDeployedDevicesKey" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeployedDevicesKey", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeployedDevicesKeyRequest", "properties": { "FriendlyName": { "type": "string", "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." }, "DeviceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "get": { "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", "tags": [ "PreviewDeployedDevicesKey" ], "parameters": [ { "name": "FleetSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "DeviceSid", "in": "query", "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$" } }, { "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": { "keys": { "type": "array", "items": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListDeployedDevicesKeyResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeployedDevicesKey", "x-maturity": [ "Preview" ] } }, "/HostedNumbers/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { "signing_document_sid": "sid" }, "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } } }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchHostedNumbersAuthorizationDocument", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateHostedNumbersAuthorizationDocument", "x-maturity": [ "Preview" ], "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." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/HostedNumbers/AuthorizationDocuments": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { "signing_document_sid": "sid" }, "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } } }, "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 } } }, { "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" } }, { "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListHostedNumbersAuthorizationDocumentResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListHostedNumbersAuthorizationDocument", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateHostedNumbersAuthorizationDocument", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/AuthorizationDocuments/{Sid}" }, "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" } }, { "name": "PhoneNumber", "in": "query", "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "schema": { "type": "string", "format": "phone-number" } }, { "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}$" } }, { "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 } } }, { "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 } } }, { "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListHostedNumbersDependentHostedNumberOrderResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListHostedNumbersDependentHostedNumberOrder", "x-maturity": [ "Preview" ] } }, "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchHostedNumbersHostedNumberOrder", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateHostedNumbersHostedNumberOrder", "x-maturity": [ "Preview" ], "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." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/HostedNumbers/HostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "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" } }, { "name": "PhoneNumber", "in": "query", "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "schema": { "type": "string", "format": "phone-number" } }, { "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}$" } }, { "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 } } }, { "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 } } }, { "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListHostedNumbersHostedNumberOrderResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListHostedNumbersHostedNumberOrder", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateHostedNumbersHostedNumberOrder", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/marketplace/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "dependentProperties": { "extensions": { "mapping": { "available_add_on_sid": "sid" }, "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } } }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMarketplaceAvailableAddOn", "x-maturity": [ "Preview" ] } }, "/marketplace/AvailableAddOns": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "dependentProperties": { "extensions": { "mapping": { "available_add_on_sid": "sid" }, "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } } }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListMarketplaceAvailableAddOnResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListMarketplaceAvailableAddOn", "x-maturity": [ "Preview" ] } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/AvailableAddOns/{Sid}", "className": "available_add_on_extension" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMarketplaceAvailableAddOnExtension", "x-maturity": [ "Preview" ] } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/AvailableAddOns/{Sid}", "className": "available_add_on_extension" }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListMarketplaceAvailableAddOnExtensionResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListMarketplaceAvailableAddOnExtension", "x-maturity": [ "Preview" ] } }, "/marketplace/InstalledAddOns": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "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" } } }, "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" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ], "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" ] } } } } }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListMarketplaceInstalledAddOnResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ] } }, "/marketplace/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "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" } } }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ], "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." } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_extension" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMarketplaceInstalledAddOnExtension", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateMarketplaceInstalledAddOnExtension", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/InstalledAddOns/{Sid}", "className": "installed_add_on_extension" }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListMarketplaceInstalledAddOnExtensionResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListMarketplaceInstalledAddOnExtension", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Documents/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "dependentProperties": { "permissions": { "mapping": { "service_sid": "service_sid", "document_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}" }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncDocument", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncDocument", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncDocumentRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] } } } } } }, "/Sync/Services/{ServiceSid}/Documents": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "dependentProperties": { "permissions": { "mapping": { "service_sid": "service_sid", "document_sid": "sid" }, "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}" }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncDocument", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncDocumentRequest", "properties": { "UniqueName": { "type": "string", "description": "" }, "Data": { "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncDocumentResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncDocument", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Services/{ServiceSid}/Documents/{Sid}", "mountName": "document_permissions" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncDocumentPermission", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncDocumentPermission", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Services/{ServiceSid}/Documents/{Sid}", "mountName": "document_permissions" }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncDocumentPermissionResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncDocumentPermission", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "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" } } }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncService", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncService", "x-maturity": [ "Preview" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/Sync/Services": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "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" } } }, "post": { "description": "", "tags": [ "PreviewSyncService" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncService", "x-maturity": [ "Preview" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": 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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncServiceResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncService", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "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" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncSyncList", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "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" }, "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" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncSyncList", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncListRequest", "properties": { "UniqueName": { "type": "string", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncSyncListResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncSyncList", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_items" }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncSyncListItem", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncSyncListItem", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncSyncListItemRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] } } } } } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_items" }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncSyncListItem", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncListItemRequest", "properties": { "Data": { "description": "" } }, "required": [ "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" } }, { "name": "From", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Bounds", "in": "query", "description": "", "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" } }, { "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncSyncListItemResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncSyncListItem", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_permissions" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncSyncListPermission", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncSyncListPermission", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", "mountName": "sync_list_permissions" }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncSyncListPermissionResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncSyncListPermission", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "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" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncSyncMap", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Maps": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "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" }, "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" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncSyncMap", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncMapRequest", "properties": { "UniqueName": { "type": "string", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncSyncMapResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncSyncMap", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_items" }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncSyncMapItem", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncSyncMapItem", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateSyncSyncMapItemRequest", "properties": { "Data": { "description": "" } }, "required": [ "Data" ] } } } } } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_items" }, "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" } } }, "headers": { "ETag": { "schema": { "type": "string" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSyncSyncMapItem", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateSyncSyncMapItemRequest", "properties": { "Key": { "type": "string", "description": "" }, "Data": { "description": "" } }, "required": [ "Key", "Data" ] } } } } }, "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" } }, { "name": "From", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Bounds", "in": "query", "description": "", "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" } }, { "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncSyncMapItemResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncSyncMapItem", "x-maturity": [ "Preview" ] } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_permissions" }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchSyncSyncMapPermission", "x-maturity": [ "Preview" ] }, "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", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateSyncSyncMapPermission", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", "mountName": "sync_map_permissions" }, "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListSyncSyncMapPermissionResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSyncSyncMapPermission", "x-maturity": [ "Preview" ] } }, "/wireless/Commands/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchWirelessCommand", "x-maturity": [ "Preview" ] } }, "/wireless/Commands": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" }, "get": { "description": "", "tags": [ "PreviewWirelessCommand" ], "parameters": [ { "name": "Device", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Sim", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Direction", "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": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/preview.wireless.command" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListWirelessCommandResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListWirelessCommand", "x-maturity": [ "Preview" ] }, "post": { "description": "", "tags": [ "PreviewWirelessCommand" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.command" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateWirelessCommand", "x-maturity": [ "Preview" ], "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" ] } } } } } }, "/wireless/RatePlans": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListWirelessRatePlanResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListWirelessRatePlan", "x-maturity": [ "Preview" ] }, "post": { "description": "", "tags": [ "PreviewWirelessRatePlan" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.rate_plan" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateWirelessRatePlan", "x-maturity": [ "Preview" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/wireless/RatePlans/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchWirelessRatePlan", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateWirelessRatePlan", "x-maturity": [ "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateWirelessRatePlanRequest", "properties": { "UniqueName": { "type": "string", "description": "" }, "FriendlyName": { "type": "string", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "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", "x-maturity": [ "Preview" ] } }, "/wireless/Sims/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "dependentProperties": { "usage": { "mapping": { "sim_sid": "sid" }, "resource_url": "/wireless/Sims/{sim_sid}/Usage" } } }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchWirelessSim", "x-maturity": [ "Preview" ] }, "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" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateWirelessSim", "x-maturity": [ "Preview" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/wireless/Sims": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "list", "dependentProperties": { "usage": { "mapping": { "sim_sid": "sid" }, "resource_url": "/wireless/Sims/{sim_sid}/Usage" } } }, "get": { "description": "", "tags": [ "PreviewWirelessSim" ], "parameters": [ { "name": "Status", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Iccid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "RatePlan", "in": "query", "description": "", "schema": { "type": "string" } }, { "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": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListWirelessSimResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListWirelessSim", "x-maturity": [ "Preview" ] } }, "/wireless/Sims/{SimSid}/Usage": { "servers": [ { "url": "https://preview.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", "parent": "/Sims/{Sid}" }, "get": { "description": "", "tags": [ "PreviewWirelessUsage" ], "parameters": [ { "name": "SimSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "End", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Start", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.sim.usage" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchWirelessUsage", "x-maturity": [ "Preview" ] } } }, "servers": [ { "url": "https://preview.twilio.com" } ], "tags": [ { "name": "PreviewDeployedDevicesCertificate" }, { "name": "PreviewDeployedDevicesDeployment" }, { "name": "PreviewDeployedDevicesDevice" }, { "name": "PreviewDeployedDevicesFleet" }, { "name": "PreviewDeployedDevicesKey" }, { "name": "PreviewHostedNumbersAuthorizationDocument" }, { "name": "PreviewHostedNumbersDependentHostedNumberOrder" }, { "name": "PreviewHostedNumbersHostedNumberOrder" }, { "name": "PreviewMarketplaceAvailableAddOn" }, { "name": "PreviewMarketplaceAvailableAddOnExtension" }, { "name": "PreviewMarketplaceInstalledAddOn" }, { "name": "PreviewMarketplaceInstalledAddOnExtension" }, { "name": "PreviewSyncDocument" }, { "name": "PreviewSyncDocumentPermission" }, { "name": "PreviewSyncService" }, { "name": "PreviewSyncSyncList" }, { "name": "PreviewSyncSyncListItem" }, { "name": "PreviewSyncSyncListPermission" }, { "name": "PreviewSyncSyncMap" }, { "name": "PreviewSyncSyncMapItem" }, { "name": "PreviewSyncSyncMapPermission" }, { "name": "PreviewWirelessCommand" }, { "name": "PreviewWirelessRatePlan" }, { "name": "PreviewWirelessSim" }, { "name": "PreviewWirelessUsage" } ], "x-maturity": [ { "name": "Preview", "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." } ] }