From ba50de2d1d4434928e5ab59f0ec832d9e6155514 Mon Sep 17 00:00:00 2001 From: sbansla Date: Thu, 12 Sep 2024 18:15:01 +0530 Subject: [PATCH 1/2] main branch of transpiler --- spec/json/twilio_api_v2010.json | 10 +- spec/json/twilio_iam_v1.json | 11 +- spec/json/twilio_intelligence_v2.json | 6 +- spec/json/twilio_marketplace_v1.json | 166 + spec/json/twilio_numbers_v2.json | 11 +- spec/json/twilio_preview.json | 11920 ++++++++++++------------ spec/yaml/twilio_api_v2010.yaml | 10 +- spec/yaml/twilio_iam_v1.yaml | 7 +- spec/yaml/twilio_intelligence_v2.yaml | 4 +- spec/yaml/twilio_marketplace_v1.yaml | 120 + spec/yaml/twilio_numbers_v2.yaml | 11 +- spec/yaml/twilio_preview.yaml | 10180 ++++++++++---------- 12 files changed, 11367 insertions(+), 11089 deletions(-) diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index ec0d6adc..99690ae8 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -11869,26 +11869,26 @@ } ], "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0", - "next_page_uri": null, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=1&PageToken=PAAPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "previous_page_uri": null, "page_size": 1, "page": 0, "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0" } }, "readEmpty": { "value": { "applications": [], "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0", "previous_page_uri": null, "page_size": 1, "start": 0, "next_page_uri": null, "page": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0" } } } diff --git a/spec/json/twilio_iam_v1.json b/spec/json/twilio_iam_v1.json index 282bd5c1..ed2c26c5 100644 --- a/spec/json/twilio_iam_v1.json +++ b/spec/json/twilio_iam_v1.json @@ -169,8 +169,6 @@ "friendly_name", "date_created" ], - "mountName": "get_api_keys", - "className": "get_api_keys", "pathType": "list" }, "get": { @@ -364,7 +362,11 @@ "accountSid_authToken": [] } ], - "operationId": "ListGetKeys" + "operationId": "ListGetKeys", + "x-twilio": { + "mountName": "get_api_keys", + "className": "get_api_keys" + } }, "post": { "description": "Create a new Signing Key for the account making the request.", @@ -500,9 +502,6 @@ } } } - }, - "x-twilio": { - "mountName": "new_api_key" } } }, diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index 77d19fc9..0e214f09 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -423,7 +423,7 @@ "type": "string", "$ref": "#/components/schemas/operator_type_enum_availability", "nullable": true, - "description": "Operator Type availability status. Possible values: internal, beta, public, retired." + "description": "Operator Type availability status. Possible values: internal, beta, general-availability, retired, deprecated." }, "configurable": { "type": "boolean", @@ -477,7 +477,9 @@ "internal", "beta", "public", - "retired" + "general-availability", + "retired", + "deprecated" ] }, "intelligence.v2.prebuilt_operator": { diff --git a/spec/json/twilio_marketplace_v1.json b/spec/json/twilio_marketplace_v1.json index 931503bd..7395ff2e 100644 --- a/spec/json/twilio_marketplace_v1.json +++ b/spec/json/twilio_marketplace_v1.json @@ -315,6 +315,60 @@ "nullable": false } } + }, + "marketplace.v1.referral_records": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XL[0-9a-fA-F]{32}$", + "nullable": false, + "description": "The unique identifier for this resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": false, + "description": "The account sid that owns this record." + }, + "net_revenue": { + "type": "number", + "nullable": false, + "description": "Net revenue collected as part of this record." + }, + "filename": { + "type": "string", + "nullable": false, + "description": "Name of the file attached to the record." + }, + "documentation_link": { + "type": "string", + "nullable": false, + "description": "Link to download record's invoice." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in UTC 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 UTC when the resource was created 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." + } + } } } }, @@ -2300,6 +2354,118 @@ } } }, + "/v1/ReferralRecords": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance" + } + }, + "/v1/ReferralRecords/{ReferralRecordSid}": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance" + }, + "get": { + "description": "Retrieve a referral record instance.", + "tags": [ + "MarketplaceReferralRecords" + ], + "parameters": [ + { + "name": "ReferralRecordSid", + "in": "path", + "description": "The SID of the Referral Record resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XL[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace.v1.referral_records" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "net_revenue": 1023.42, + "filename": "myfile.pdf", + "documentation_link": "https://somelink.com", + "date_created": "2024-07-31T18:51:03Z", + "date_updated": "2024-07-31T18:51:03Z", + "url": "https://marketplace.twilio.com/v1/ReferralRecords/XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchReferralRecords" + } + }, "/v1/Listing/{Sid}": { "servers": [ { diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index 109923a7..ddac512c 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -2260,7 +2260,7 @@ }, "NumberType": { "type": "string", - "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll free`." + "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`." }, "IsTest": { "type": "boolean", @@ -2369,7 +2369,7 @@ { "name": "NumberType", "in": "query", - "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`.", + "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.", "schema": { "type": "string" }, @@ -3083,7 +3083,7 @@ "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "friendly_name", - "status": "draft", + "status": "twilio-approved", "valid_until": "2015-07-30T20:00:00Z", "email": "email", "status_callback": "http://www.example.com", @@ -3156,7 +3156,7 @@ }, "MoveToDraft": { "type": "boolean", - "description": "This is to determine whether the cloned bundle needs to be in draft state or not." + "description": "If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved" }, "FriendlyName": { "type": "string", @@ -3171,8 +3171,7 @@ "create": { "value": { "FriendlyName": "friendly_name", - "TargetAccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", - "MoveToDraft": true + "TargetAccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" } } } diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index 39a03a8a..43e6450e 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -7,94 +7,100 @@ } }, "schemas": { - "preview.deployed_devices.fleet.certificate": { + "preview.hosted_numbers.authorization_document": { "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", + "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to." + "description": "A 34 character string that uniquely identifies this AuthorizationDocument." }, - "account_sid": { + "address_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Account responsible for this Certificate credential." + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, - "device_sid": { + "status": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", + "$ref": "#/components/schemas/authorization_document_enum_status", "nullable": true, - "description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential." + "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." }, - "thumbprint": { + "email": { "type": "string", "nullable": true, - "description": "Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device." + "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": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." + "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": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format." + "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 } } }, - "preview.deployed_devices.fleet.deployment": { + "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": "^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", + "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Fleet that the given Deployment belongs to." + "description": "A 34 character string that uniquely identifies this Authorization Document" }, "account_sid": { "type": "string", @@ -102,318 +108,194 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Account responsible for this Deployment." + "description": "The unique SID identifier of the Account." }, - "sync_service_sid": { + "incoming_phone_number_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "pattern": "^PN[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." + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." }, - "date_created": { + "address_sid": { "type": "string", - "format": "date-time", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the date this Deployment was created, given in UTC ISO 8601 format." + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." }, - "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": { + "signing_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", + "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "Contains a 34 character string that uniquely identifies this Device resource." + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." }, - "url": { + "phone_number": { "type": "string", - "format": "uri", + "format": "phone-number", "nullable": true, - "description": "Contains an absolute URL for this Device resource." + "description": "An E164 formatted phone number hosted by this HostedNumberOrder." }, - "unique_name": { - "type": "string", + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } + }, "nullable": true, - "description": "Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long." + "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." }, "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." + "description": "A human readable description of this resource, up to 64 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "account_sid": { + "unique_name": { "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." + "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 + } + } }, - "identity": { + "status": { "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", "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." + "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." }, - "deployment_sid": { + "failure_reason": { "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." + "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": "Specifies the date this Device was created, given in UTC ISO 8601 format." + "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": "Specifies the date this Device was last updated, given in UTC ISO 8601 format." + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) 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." + "verification_attempts": { + "type": "integer", + "default": 0, + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, - "url": { + "email": { "type": "string", - "format": "uri", "nullable": true, - "description": "Contains an absolute URL for this Fleet resource." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "unique_name": { - "type": "string", + "cc_emails": { + "type": "array", + "items": { + "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." + "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": { + "verification_type": { "type": "string", - "format": "date-time", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", "nullable": true, - "description": "Specifies the date this Key credential was created, given in UTC ISO 8601 format." + "description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." }, - "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": { + "verification_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", + "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this AuthorizationDocument." + "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." }, - "address_sid": { + "extension": { "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." + "description": "A numerical extension to be used when making the ownership verification call." }, - "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." + "call_delay": { + "type": "integer", + "default": 0, + "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, - "email": { + "verification_code": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The digits passed during the ownership verification call." }, - "cc_emails": { + "verification_call_sids": { "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 + "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } }, - "authorization_document_enum_status": { + "dependent_hosted_number_order_enum_status": { "type": "string", "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" ] }, - "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { + "dependent_hosted_number_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, + "preview.hosted_numbers.hosted_number_order": { "type": "object", "properties": { "sid": { @@ -422,7 +304,7 @@ "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this Authorization Document" + "description": "A 34 character string that uniquely identifies this HostedNumberOrder." }, "account_sid": { "type": "string", @@ -430,7 +312,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Account." + "description": "A 34 character string that uniquely identifies the account." }, "incoming_phone_number_sid": { "type": "string", @@ -438,7 +320,7 @@ "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." + "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", @@ -454,13 +336,13 @@ "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." + "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": "An E164 formatted phone number hosted by this HostedNumberOrder." + "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", @@ -480,12 +362,12 @@ } }, "nullable": true, - "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." + "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 human readable description of this resource, up to 64 characters.", + "description": "A 64 character string that is a human-readable text that describes this resource.", "x-twilio": { "pii": { "handling": "standard", @@ -506,9 +388,9 @@ }, "status": { "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", + "$ref": "#/components/schemas/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." + "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", @@ -549,7 +431,7 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", "x-twilio": { "pii": { "handling": "standard", @@ -557,11 +439,17 @@ } } }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this HostedNumberOrder." + }, "verification_type": { "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", + "$ref": "#/components/schemas/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." + "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", @@ -584,7 +472,7 @@ "verification_code": { "type": "string", "nullable": true, - "description": "The digits passed during the ownership verification call." + "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", @@ -596,7 +484,7 @@ } } }, - "dependent_hosted_number_order_enum_status": { + "hosted_number_order_enum_status": { "type": "string", "enum": [ "received", @@ -610,243 +498,33 @@ "action-required" ] }, - "dependent_hosted_number_order_enum_verification_type": { + "hosted_number_order_enum_verification_type": { "type": "string", "enum": [ "phone-call", "phone-bill" ] }, - "preview.hosted_numbers.hosted_number_order": { + "preview.marketplace.available_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", + "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this HostedNumberOrder." + "description": "The unique string that we created to identify the AvailableAddOn resource." }, - "account_sid": { + "friendly_name": { "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." + "description": "The string that you assigned to describe the resource." }, - "incoming_phone_number_sid": { + "description": { "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", - "default": 0, - "description": "The number of attempts made to verify ownership of the phone number that is being hosted." - }, - "email": { - "type": "string", - "nullable": true, - "description": "Email of the owner of this phone number that is being hosted.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - "cc_emails": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of this HostedNumberOrder." - }, - "verification_type": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "nullable": true, - "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." - }, - "verification_document_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." - }, - "extension": { - "type": "string", - "nullable": true, - "description": "A numerical extension to be used when making the ownership verification call." - }, - "call_delay": { - "type": "integer", - "default": 0, - "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." - }, - "verification_code": { - "type": "string", - "nullable": true, - "description": "A verification code provided in the response for a user to enter when they pick up the phone call." - }, - "verification_call_sids": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." - } - } - }, - "hosted_number_order_enum_status": { - "type": "string", - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ] - }, - "hosted_number_order_enum_verification_type": { - "type": "string", - "enum": [ - "phone-call", - "phone-bill" - ] - }, - "preview.marketplace.available_add_on": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the AvailableAddOn resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." - }, - "description": { - "type": "string", - "nullable": true, - "description": "A short description of the Add-on's functionality." + "description": "A short description of the Add-on's functionality." }, "pricing_type": { "type": "string", @@ -1024,49 +702,51 @@ } } }, - "preview.sync.service.document": { + "preview.wireless.command": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", + "pattern": "^DC[0-9a-fA-F]{32}$", "nullable": true }, - "unique_name": { + "account_sid": { "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "account_sid": { + "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, - "service_sid": { + "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, - "url": { + "command": { "type": "string", - "format": "uri", "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", + "command_mode": { + "type": "string", "nullable": true }, - "revision": { + "status": { "type": "string", "nullable": true }, - "data": { + "direction": { + "type": "string", "nullable": true }, "date_created": { @@ -1079,75 +759,98 @@ "format": "date-time", "nullable": true }, - "created_by": { + "url": { "type": "string", + "format": "uri", "nullable": true } } }, - "preview.sync.service.document.document_permission": { + "preview.wireless.rate_plan": { "type": "object", "properties": { - "account_sid": { + "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." + "pattern": "^WP[0-9a-fA-F]{32}$", + "nullable": true }, - "service_sid": { + "unique_name": { "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." + "nullable": true }, - "document_sid": { + "account_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." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "identity": { + "friendly_name": { "type": "string", - "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." + "nullable": true }, - "read": { + "data_enabled": { "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync Document." + "nullable": true }, - "write": { + "data_metering": { + "type": "string", + "nullable": true + }, + "data_limit": { + "type": "integer", + "default": 0 + }, + "messaging_enabled": { "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can update the Sync Document." + "nullable": true }, - "manage": { + "voice_enabled": { "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync Document." + "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, - "description": "Contains an absolute URL for this Sync Document Permission." + "nullable": true } } }, - "preview.sync.service": { + "preview.wireless.sim": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true + }, + "unique_name": { + "type": "string", "nullable": true }, "account_sid": { @@ -1157,85 +860,92 @@ "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 }, - "date_created": { + "iccid": { "type": "string", - "format": "date-time", "nullable": true }, - "date_updated": { + "e_id": { "type": "string", - "format": "date-time", "nullable": true }, - "url": { + "status": { "type": "string", - "format": "uri", "nullable": true }, - "webhook_url": { + "commands_callback_url": { "type": "string", "format": "uri", "nullable": true }, - "reachability_webhooks_enabled": { - "type": "boolean", + "commands_callback_method": { + "type": "string", "nullable": true }, - "acl_enabled": { - "type": "boolean", + "sms_fallback_method": { + "type": "string", + "format": "http-method", + "enum": [ + "GET", + "POST" + ], "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true - } - } - }, - "preview.sync.service.sync_list": { - "type": "object", - "properties": { - "sid": { + "sms_fallback_url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "format": "uri", "nullable": true }, - "unique_name": { + "sms_method": { "type": "string", + "format": "http-method", + "enum": [ + "GET", + "POST" + ], "nullable": true }, - "account_sid": { + "sms_url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "format": "uri", "nullable": true }, - "service_sid": { + "voice_fallback_method": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "format": "http-method", + "enum": [ + "GET", + "POST" + ], "nullable": true }, - "url": { + "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", + "voice_method": { + "type": "string", + "format": "http-method", + "enum": [ + "GET", + "POST" + ], "nullable": true }, - "revision": { + "voice_url": { "type": "string", + "format": "uri", "nullable": true }, "date_created": { @@ -1248,392 +958,391 @@ "format": "date-time", "nullable": true }, - "created_by": { + "url": { "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", "nullable": true } } }, - "preview.sync.service.sync_list.sync_list_item": { + "preview.wireless.sim.usage": { "type": "object", "properties": { - "index": { - "type": "integer", - "default": 0 - }, - "account_sid": { + "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, - "service_sid": { + "sim_unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "list_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "url": { - "type": "string", - "format": "uri", + "period": { "nullable": true }, - "revision": { - "type": "string", + "commands_usage": { "nullable": true }, - "data": { + "commands_costs": { "nullable": true }, - "date_created": { - "type": "string", - "format": "date-time", + "data_usage": { "nullable": true }, - "date_updated": { - "type": "string", - "format": "date-time", + "data_costs": { "nullable": true }, - "created_by": { + "url": { "type": "string", + "format": "uri", "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": { + "preview.deployed_devices.fleet.certificate": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^CY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Twilio Account." + "description": "Contains a 34 character string that uniquely identifies this Certificate credential resource." }, - "service_sid": { + "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": "^IS[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Sync Service Instance." + "description": "Specifies the unique string identifier of the Account responsible for this Certificate credential." }, - "list_sid": { + "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Sync List to which the Permission applies." + "description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential." }, - "identity": { + "thumbprint": { "type": "string", "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." + "description": "Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device." }, - "read": { - "type": "boolean", + "date_created": { + "type": "string", + "format": "date-time", "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." + "description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." }, - "url": { + "date_updated": { "type": "string", - "format": "uri", + "format": "date-time", "nullable": true, - "description": "Contains an absolute URL for this Sync List Permission." + "description": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format." } } }, - "preview.sync.service.sync_map": { + "preview.deployed_devices.fleet.deployment": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^DL[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Contains a 34 character string that uniquely identifies this Deployment resource." }, - "unique_name": { + "url": { "type": "string", - "nullable": true + "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 + "nullable": true, + "description": "Specifies the unique string identifier of the Account responsible for this Deployment." }, - "service_sid": { + "sync_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 + "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 + "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 - }, - "created_by": { - "type": "string", - "nullable": true + "nullable": true, + "description": "Specifies the date this Deployment was last updated, given in UTC ISO 8601 format." } } }, - "preview.sync.service.sync_map.sync_map_item": { + "preview.deployed_devices.fleet.device": { "type": "object", "properties": { - "key": { - "type": "string", - "nullable": true - }, - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^TH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Contains a 34 character string that uniquely identifies this Device resource." }, - "service_sid": { + "url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true + "format": "uri", + "nullable": true, + "description": "Contains an absolute URL for this Device resource." }, - "map_sid": { + "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": "^MP[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Specifies the unique string identifier of the Account responsible for this Device." }, - "url": { + "identity": { "type": "string", - "format": "uri", - "nullable": true + "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." }, - "revision": { + "deployment_sid": { "type": "string", - "nullable": true - }, - "data": { - "nullable": true + "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 + "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 + "nullable": true, + "description": "Specifies the date this Device was last updated, given in UTC ISO 8601 format." }, - "created_by": { + "date_authenticated": { "type": "string", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "Specifies the date this Device was last authenticated, given in UTC ISO 8601 format." } } }, - "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": { + "preview.deployed_devices.fleet": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Twilio Account." + "description": "Contains a 34 character string that uniquely identifies this Fleet resource." }, - "service_sid": { + "url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "format": "uri", "nullable": true, - "description": "The unique SID identifier of the Sync Service Instance." + "description": "Contains an absolute URL for this Fleet resource." }, - "map_sid": { + "unique_name": { "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." + "description": "Contains a unique and addressable name of this Fleet, e.g. 'default', up to 128 characters long." }, - "identity": { + "friendly_name": { "type": "string", "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." + "description": "Contains a human readable descriptive text for this Fleet, up to 256 characters long." }, - "read": { - "type": "boolean", + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync Map and its Items." + "description": "Speicifies the unique string identifier of the Account responsible for this Fleet." }, - "write": { - "type": "boolean", + "default_deployment_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." + "description": "Contains the string identifier of the automatically provisioned default Deployment of this Fleet." }, - "manage": { - "type": "boolean", + "date_created": { + "type": "string", + "format": "date-time", "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync Map." + "description": "Specifies the date this Fleet was created, given in UTC ISO 8601 format." }, - "url": { + "date_updated": { "type": "string", - "format": "uri", + "format": "date-time", "nullable": true, - "description": "Contains an absolute URL for this Sync Map Permission." + "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.wireless.command": { + "preview.deployed_devices.fleet.key": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", - "nullable": true + "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 + "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": "^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 + "pattern": "^TH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Specifies the unique string identifier of a Device authenticated with this Key credential." }, - "direction": { + "secret": { "type": "string", - "nullable": true + "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 + "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 - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true + "nullable": true, + "description": "Specifies the date this Key credential was last updated, given in UTC ISO 8601 format." } } }, - "preview.wireless.rate_plan": { + "preview.sync.service.document": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", + "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { @@ -1647,39 +1356,28 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "friendly_name": { + "service_sid": { "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "data_enabled": { - "type": "boolean", - "nullable": true - }, - "data_metering": { + "url": { "type": "string", + "format": "uri", "nullable": true }, - "data_limit": { - "type": "integer", - "default": 0 - }, - "messaging_enabled": { - "type": "boolean", - "nullable": true - }, - "voice_enabled": { - "type": "boolean", + "links": { + "type": "object", + "format": "uri-map", "nullable": true }, - "national_roaming_enabled": { - "type": "boolean", + "revision": { + "type": "string", "nullable": true }, - "international_roaming": { - "type": "array", - "items": { - "type": "string" - }, + "data": { "nullable": true }, "date_created": { @@ -1692,120 +1390,163 @@ "format": "date-time", "nullable": true }, - "url": { + "created_by": { "type": "string", - "format": "uri", "nullable": true } } }, - "preview.wireless.sim": { + "preview.sync.service.document.document_permission": { "type": "object", "properties": { - "sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Twilio Account." }, - "unique_name": { + "service_sid": { "type": "string", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Sync Service Instance." }, - "account_sid": { + "document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "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 }, - "rate_plan_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, - "iccid": { + "date_created": { "type": "string", + "format": "date-time", "nullable": true }, - "e_id": { + "date_updated": { "type": "string", + "format": "date-time", "nullable": true }, - "status": { + "url": { "type": "string", + "format": "uri", "nullable": true }, - "commands_callback_url": { + "webhook_url": { "type": "string", "format": "uri", "nullable": true }, - "commands_callback_method": { - "type": "string", + "reachability_webhooks_enabled": { + "type": "boolean", "nullable": true }, - "sms_fallback_method": { - "type": "string", - "format": "http-method", - "enum": [ - "GET", - "POST" - ], + "acl_enabled": { + "type": "boolean", "nullable": true }, - "sms_fallback_url": { + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + } + } + }, + "preview.sync.service.sync_list": { + "type": "object", + "properties": { + "sid": { "type": "string", - "format": "uri", + "minLength": 34, + "maxLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true }, - "sms_method": { + "unique_name": { "type": "string", - "format": "http-method", - "enum": [ - "GET", - "POST" - ], "nullable": true }, - "sms_url": { + "account_sid": { "type": "string", - "format": "uri", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "voice_fallback_method": { + "service_sid": { "type": "string", - "format": "http-method", - "enum": [ - "GET", - "POST" - ], + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "voice_fallback_url": { + "url": { "type": "string", "format": "uri", "nullable": true }, - "voice_method": { - "type": "string", - "format": "http-method", - "enum": [ - "GET", - "POST" - ], + "links": { + "type": "object", + "format": "uri-map", "nullable": true }, - "voice_url": { + "revision": { "type": "string", - "format": "uri", "nullable": true }, "date_created": { @@ -1818,58 +1559,317 @@ "format": "date-time", "nullable": true }, - "url": { + "created_by": { "type": "string", - "format": "uri", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", "nullable": true } } }, - "preview.wireless.sim.usage": { + "preview.sync.service.sync_list.sync_list_item": { "type": "object", "properties": { - "sim_sid": { + "index": { + "type": "integer", + "default": 0 + }, + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "sim_unique_name": { + "service_sid": { "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "account_sid": { + "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true }, - "period": { + "url": { + "type": "string", + "format": "uri", "nullable": true }, - "commands_usage": { - "nullable": true + "revision": { + "type": "string", + "nullable": true }, - "commands_costs": { + "data": { "nullable": true }, - "data_usage": { + "date_created": { + "type": "string", + "format": "date-time", "nullable": true }, - "data_costs": { + "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." } } } @@ -1892,7 +1892,7 @@ }, "openapi": "3.0.1", "paths": { - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "/HostedNumbers/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -1901,33 +1901,125 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + }, "pathType": "instance" }, "get": { - "description": "Fetch information about a specific Certificate credential in the Fleet.", + "description": "Fetch a specific AuthorizationDocument.", "tags": [ - "PreviewDeployedDevicesCertificate" + "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { - "name": "FleetSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "examples": { + "fetch": { + "value": { + "address_sid": "AD11111111111111111111111111111111", + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchHostedNumbersAuthorizationDocument" + }, + "post": { + "description": "Updates a specific AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], + "parameters": [ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true } @@ -1937,20 +2029,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { - "fetch": { + "update": { "value": { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -2000,74 +2097,162 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesCertificate" + "operationId": "UpdateHostedNumbersAuthorizationDocument", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateHostedNumbersAuthorizationDocumentRequest", + "properties": { + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "Email": { + "type": "string", + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + }, + "Status": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "ContactPhoneNumber": { + "type": "string", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + } + } + }, + "examples": { + "update": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "Status": "signing", + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" + } + } + } + } + } + } + } + }, + "/HostedNumbers/AuthorizationDocuments": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + }, + "pathType": "list" }, - "delete": { - "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "get": { + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", "tags": [ - "PreviewDeployedDevicesCertificate" + "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { - "name": "FleetSid", - "in": "path", - "description": "", + "name": "Email", + "in": "query", + "description": "Email that this AuthorizationDocument will be sent to for signing.", "schema": { "type": "string" }, - "required": true + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } + } }, { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "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", - "minLength": 34, - "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "$ref": "#/components/schemas/authorization_document_enum_status" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ + "examples": { + "readEmpty": { + "value": "signed" + } + } + }, { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesCertificate" - }, - "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": "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": "FleetSid", - "in": "path", - "description": "", + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", "schema": { - "type": "string" - }, - "required": true + "type": "integer", + "minimum": 0 + } }, { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -2075,20 +2260,93 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "title": "ListHostedNumbersAuthorizationDocumentResponse" }, "examples": { - "update": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { "value": { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" + }, + "items": [ + { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2138,87 +2396,37 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesCertificate", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" + "operationId": "ListHostedNumbersAuthorizationDocument" }, "post": { - "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", "tags": [ - "PreviewDeployedDevicesCertificate" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } + "PreviewHostedNumbersAuthorizationDocument" ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { "create": { "value": { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -2268,71 +2476,189 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesCertificate", + "operationId": "CreateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesCertificateRequest", + "title": "CreateHostedNumbersAuthorizationDocumentRequest", "properties": { - "CertificateData": { + "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", - "description": "Provides a URL encoded representation of the public certificate in PEM format." + "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." }, - "FriendlyName": { + "Email": { "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + "description": "Email that this AuthorizationDocument will be sent to for signing." }, - "DeviceSid": { + "ContactTitle": { "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." + "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": [ - "CertificateData" + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" ] }, "examples": { "create": { "value": { - "CertificateData": "12345678abcdef", - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" } } } } - } - } - }, - "get": { - "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", - "tags": [ - "PreviewDeployedDevicesCertificate" - ], - "parameters": [ + } + } + } + }, + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AuthorizationDocuments/{Sid}", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersDependentHostedNumberOrder" + ], + "parameters": [ + { + "name": "SigningDocumentSid", + "in": "path", + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, { - "name": "FleetSid", - "in": "path", - "description": "", + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", "schema": { "type": "string" }, - "required": true + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } }, { - "name": "DeviceSid", + "name": "UniqueName", "in": "query", - "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "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", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "something123" + } } }, { @@ -2370,10 +2696,10 @@ "schema": { "type": "object", "properties": { - "certificates": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" } }, "meta": { @@ -2409,47 +2735,69 @@ "type": "object" } }, - "title": "ListDeployedDevicesCertificateResponse" + "title": "ListHostedNumbersDependentHostedNumberOrderResponse" }, "examples": { "readEmpty": { "value": { - "certificates": [], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", - "key": "certificates", + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "items": [] } }, "readFull": { "value": { - "certificates": [ - { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", - "key": "certificates", + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", + "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "failure_reason": "", + "unique_name": "foobar", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + ] } } } @@ -2499,10 +2847,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesCertificate" + "operationId": "ListHostedNumbersDependentHostedNumberOrder" } }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { + "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -2511,33 +2859,23 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "Fetch information about a specific Deployment in the Fleet.", + "description": "Fetch a specific HostedNumberOrder.", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewHostedNumbersHostedNumberOrder" ], "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.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -2547,19 +2885,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { "fetch": { "value": { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "5105", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" } } } @@ -2609,32 +2971,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesDeployment" + "operationId": "FetchHostedNumbersHostedNumberOrder" }, "delete": { - "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewHostedNumbersHostedNumberOrder" ], "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.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -2649,32 +3002,23 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesDeployment" + "operationId": "DeleteHostedNumbersHostedNumberOrder" }, "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.", + "description": "Updates a specific HostedNumberOrder.", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewHostedNumbersHostedNumberOrder" ], "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.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -2684,19 +3028,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { "update": { "value": { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "new friendly name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "pending-loa", + "unique_name": "new unique name", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 1, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" } } } @@ -2746,32 +3114,77 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesDeployment", + "operationId": "UpdateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesDeploymentRequest", + "title": "UpdateHostedNumbersHostedNumberOrderRequest", "properties": { "FriendlyName": { "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" + "description": "A 64 character string that is a human readable text that describes this resource." }, - "SyncServiceSid": { + "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": "^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." + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + }, + "Extension": { + "type": "string", + "description": "Digits to dial after connecting the verification call." + }, + "CallDelay": { + "type": "integer", + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." } } }, "examples": { "update": { "value": { - "FriendlyName": "friendly_name", - "SyncServiceSid": "sync_service_sid" + "FriendlyName": "new friendly name", + "UniqueName": "new unique name", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "Status": "pending-loa", + "Extension": "1234", + "CallDelay": 15 } } } @@ -2780,7 +3193,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "/HostedNumbers/HostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" @@ -2789,139 +3202,95 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", "pathType": "list" }, - "post": { - "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", + "get": { + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { - "name": "FleetSid", - "in": "path", - "description": "", + "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" + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - }, - "examples": { - "create": { - "value": { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } + "examples": { + "readEmpty": { + "value": "completed" } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } + "examples": { + "readEmpty": { + "value": "+19193608000" } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" }, - "description": "Created" - } - }, - "security": [ + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } + } + }, { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDeployment", - "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." - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name", - "SyncServiceSid": "sync_service_sid" - } - } + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" } } - } - } - }, - "get": { - "description": "Retrieve a list of all Deployments belonging to the Fleet.", - "tags": [ - "PreviewDeployedDevicesDeployment" - ], - "parameters": [ + }, { - "name": "FleetSid", - "in": "path", - "description": "", + "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" }, - "required": true + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "something123" + } + } }, { "name": "PageSize", @@ -2958,10 +3327,10 @@ "schema": { "type": "object", "properties": { - "deployments": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } }, "meta": { @@ -2997,157 +3366,70 @@ "type": "object" } }, - "title": "ListDeployedDevicesDeploymentResponse" + "title": "ListHostedNumbersHostedNumberOrderResponse" }, "examples": { "readEmpty": { "value": { - "deployments": [], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", - "key": "deployments", + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", + "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" + }, + "items": [] } }, "readFull": { "value": { - "deployments": [ - { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", - "key": "deployments", + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", + "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" - } - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesDeployment" - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + ] } } } @@ -3183,106 +3465,123 @@ }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDevice" - }, - "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" - }, - "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" + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } }, - "required": true + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] } ], + "operationId": "ListHostedNumbersHostedNumberOrder" + }, + "post": { + "description": "Host a phone number's capability on Twilio's platform.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { - "update": { + "create": { "value": { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithPhoneBillVerification": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_type": "phone-bill" } } } @@ -3324,7 +3623,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -3332,40 +3631,144 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesDevice", + "operationId": "CreateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesDeviceRequest", + "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": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." + "description": "A 64 character string that is a human readable text that describes this resource." }, - "Identity": { + "UniqueName": { "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + "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." }, - "DeploymentSid": { + "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": "^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." + "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." }, - "Enabled": { - "type": "boolean", - "description": "" + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." } - } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ] }, "examples": { - "update": { + "create": { "value": { - "FriendlyName": "friendly_name", - "Identity": "identity" + "AddressSid": "AD11111111111111111111111111111111", + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "Email": "test@twilio.com" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true + } + }, + "createWithPhoneBillVerification": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "VerificationType": "phone-bill", + "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -3374,7 +3777,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "/marketplace/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -3383,47 +3786,64 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + } + }, + "pathType": "instance" }, - "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.", + "get": { + "description": "Fetch an instance of an Add-on currently available to be installed.", "tags": [ - "PreviewDeployedDevicesDevice" + "PreviewMarketplaceAvailableAddOn" ], "parameters": [ { - "name": "FleetSid", + "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn resource to fetch.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + "$ref": "#/components/schemas/preview.marketplace.available_add_on" }, "examples": { - "create": { + "fetch": { "value": { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } } } } @@ -3465,7 +3885,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -3473,78 +3893,34 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesDevice", - "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": "" - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name", - "UniqueName": "unique_name", - "Identity": "identity" - } - } - } - } - } + "operationId": "FetchMarketplaceAvailableAddOn" + } + }, + "/marketplace/AvailableAddOns": { + "servers": [ + { + "url": "https://preview.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + } + }, + "pathType": "list" }, "get": { - "description": "Retrieve a list of all Devices belonging to the Fleet.", + "description": "Retrieve a list of Add-ons currently available to be installed.", "tags": [ - "PreviewDeployedDevicesDevice" + "PreviewMarketplaceAvailableAddOn" ], "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", @@ -3580,10 +3956,10 @@ "schema": { "type": "object", "properties": { - "devices": { + "available_add_ons": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + "$ref": "#/components/schemas/preview.marketplace.available_add_on" } }, "meta": { @@ -3619,49 +3995,56 @@ "type": "object" } }, - "title": "ListDeployedDevicesDeviceResponse" + "title": "ListMarketplaceAvailableAddOnResponse" }, "examples": { - "readEmpty": { + "readFull": { "value": { - "devices": [], + "available_add_ons": [ + { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", - "key": "devices", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" } } }, - "readFull": { + "readEmpty": { "value": { - "devices": [ - { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], + "available_add_ons": [], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", - "key": "devices", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" } } } @@ -3712,58 +4095,49 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesDevice" + "operationId": "ListMarketplaceAvailableAddOn" } }, - "/DeployedDevices/Fleets/{Sid}": { + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "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" - } - }, + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", "pathType": "instance" }, "get": { - "description": "Fetch information about a specific Fleet in your account.", + "description": "Fetch an instance of an Extension for the Available Add-on.", "tags": [ - "PreviewDeployedDevicesFleet" + "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": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "The SID of the AvailableAddOn Extension resource to fetch.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } @@ -3773,25 +4147,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" }, "examples": { "fetch": { "value": { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" - } + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -3841,50 +4207,66 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesFleet" + "operationId": "FetchMarketplaceAvailableAddOnExtension" + } + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "list" }, - "delete": { - "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "get": { + "description": "Retrieve a list of Extensions for the Available Add-on.", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewMarketplaceAvailableAddOnExtension" ], "parameters": [ { - "name": "Sid", + "name": "AvailableAddOnSid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "The SID of the AvailableAddOn resource with the extensions to read.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ + }, { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesFleet" - }, - "post": { - "description": "Update the friendly name property of a specific Fleet in 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": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "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" - }, - "required": true + } } ], "responses": { @@ -3892,24 +4274,84 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "type": "object", + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "title": "ListMarketplaceAvailableAddOnExtensionResponse" }, "examples": { - "update": { + "readFull": { "value": { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + }, + "readEmpty": { + "value": { + "extensions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -3941,60 +4383,29 @@ "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesFleet", - "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." - } + "type": "boolean" } }, - "examples": { - "update": { - "value": { - "FriendlyName": "friendly_name", - "DefaultDeploymentSid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceAvailableAddOnExtension" } }, - "/DeployedDevices/Fleets": { + "/marketplace/InstalledAddOns": { "servers": [ { "url": "https://preview.twilio.com" @@ -4004,61 +4415,50 @@ "x-twilio": { "defaultOutputProperties": [], "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": { + "extensions": { "mapping": { - "fleet_sid": "sid" + "installed_add_on_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" }, - "keys": { + "usage": { "mapping": { - "fleet_sid": "sid" + "installed_add_on_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } }, "pathType": "list" }, "post": { - "description": "Create a new Fleet for scoping of deployed devices within your account.", + "description": "Install an Add-on for the Account specified.", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewMarketplaceInstalledAddOn" ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { "create": { "value": { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_1", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -4109,24 +4509,45 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesFleet", + "operationId": "CreateMarketplaceInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesFleetRequest", + "title": "CreateMarketplaceInstalledAddOnRequest", "properties": { - "FriendlyName": { + "AvailableAddOnSid": { "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "description": "The SID of the AvaliableAddOn to install." + }, + "AcceptTermsOfService": { + "type": "boolean", + "description": "Whether the Terms of Service were accepted." + }, + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } - } + }, + "required": [ + "AvailableAddOnSid", + "AcceptTermsOfService" + ] }, "examples": { "create": { "value": { - "FriendlyName": "friendly_name" + "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AcceptTermsOfService": true, + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_1" } } } @@ -4135,9 +4556,9 @@ } }, "get": { - "description": "Retrieve a list of all Fleets belonging to your account.", + "description": "Retrieve a list of Add-ons currently installed on this Account.", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewMarketplaceInstalledAddOn" ], "parameters": [ { @@ -4175,10 +4596,10 @@ "schema": { "type": "object", "properties": { - "fleets": { + "installed_add_ons": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } }, "meta": { @@ -4214,51 +4635,52 @@ "type": "object" } }, - "title": "ListDeployedDevicesFleetResponse" + "title": "ListMarketplaceInstalledAddOnResponse" }, "examples": { - "readEmpty": { - "value": { - "fleets": [], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", - "key": "fleets", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" - } - } - }, "readFull": { "value": { - "fleets": [ + "installed_add_ons": [ { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } ], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", - "key": "fleets", + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "next_page_url": null, + "key": "installed_add_ons" + } + } + }, + "readEmpty": { + "value": { + "installed_add_ons": [], + "meta": { "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" } } } @@ -4309,10 +4731,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesFleet" + "operationId": "ListMarketplaceInstalledAddOn" } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "/marketplace/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4321,33 +4743,68 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" + } + }, "pathType": "instance" }, - "get": { - "description": "Fetch information about a specific Key credential in the Fleet.", + "delete": { + "description": "Remove an Add-on installation from your account", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewMarketplaceInstalledAddOn" ], "parameters": [ { - "name": "FleetSid", + "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource to delete.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteMarketplaceInstalledAddOn" + }, + "get": { + "description": "Fetch an instance of an Add-on currently installed on this Account.", + "tags": [ + "PreviewMarketplaceInstalledAddOn" + ], + "parameters": [ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "description": "The SID of the InstalledAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } @@ -4357,20 +4814,26 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { "fetch": { "value": { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } } } @@ -4420,72 +4883,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesKey" - }, - "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" + "operationId": "FetchMarketplaceInstalledAddOn" }, "post": { - "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "description": "Update an Add-on installation for the Account specified.", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewMarketplaceInstalledAddOn" ], "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.", + "description": "The SID of the InstalledAddOn resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } @@ -4495,20 +4909,26 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { "update": { "value": { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_2", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } } } @@ -4558,32 +4978,28 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesKey", + "operationId": "UpdateMarketplaceInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesKeyRequest", + "title": "UpdateMarketplaceInstalledAddOnRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + "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" }, - "DeviceSid": { + "UniqueName": { "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." + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } } }, "examples": { "update": { "value": { - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_2" } } } @@ -4592,7 +5008,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4601,44 +5017,157 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", + "pathType": "instance" + }, + "get": { + "description": "Fetch an instance of an Extension for the Installed Add-on.", + "tags": [ + "PreviewMarketplaceInstalledAddOnExtension" + ], + "parameters": [ + { + "name": "InstalledAddOnSid", + "in": "path", + "description": "The SID of the InstalledAddOn resource with the extension to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceInstalledAddOnExtension" }, "post": { - "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "description": "Update an Extension for an Add-on installation.", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewMarketplaceInstalledAddOnExtension" ], "parameters": [ { - "name": "FleetSid", + "name": "InstalledAddOnSid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource with the extension to update.", "schema": { - "type": "string" + "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": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" }, "examples": { - "create": { + "update": { "value": { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": false, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -4680,7 +5209,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -4688,64 +5217,65 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesKey", + "operationId": "UpdateMarketplaceInstalledAddOnExtension", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesKeyRequest", + "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", "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." + "Enabled": { + "type": "boolean", + "description": "Whether the Extension should be invoked." } - } + }, + "required": [ + "Enabled" + ] }, "examples": { - "create": { + "update": { "value": { - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" + "Enabled": false } } } } } } + } + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", + "pathType": "list" }, "get": { - "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "description": "Retrieve a list of Extensions for the Installed Add-on.", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewMarketplaceInstalledAddOnExtension" ], "parameters": [ { - "name": "FleetSid", + "name": "InstalledAddOnSid", "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.", + "description": "The SID of the InstalledAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" - } + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -4782,10 +5312,10 @@ "schema": { "type": "object", "properties": { - "keys": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } }, "meta": { @@ -4821,46 +5351,44 @@ "type": "object" } }, - "title": "ListDeployedDevicesKeyResponse" + "title": "ListMarketplaceInstalledAddOnExtensionResponse" }, "examples": { - "readEmpty": { + "readFull": { "value": { - "keys": [], + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", - "key": "keys", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } }, - "readFull": { + "readEmpty": { "value": { - "keys": [ - { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], + "extensions": [], "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", - "key": "keys", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -4911,10 +5439,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesKey" + "operationId": "ListMarketplaceInstalledAddOnExtension" } }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "/wireless/Commands/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4923,125 +5451,23 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "dependent_hosted_number_orders": { - "mapping": { - "signing_document_sid": "sid" - }, - "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" - } - }, "pathType": "instance" }, "get": { - "description": "Fetch a specific AuthorizationDocument.", - "tags": [ - "PreviewHostedNumbersAuthorizationDocument" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - }, - "examples": { - "fetch": { - "value": { - "address_sid": "AD11111111111111111111111111111111", - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchHostedNumbersAuthorizationDocument" - }, - "post": { - "description": "Updates a specific AuthorizationDocument.", + "description": "", "tags": [ - "PreviewHostedNumbersAuthorizationDocument" + "PreviewWirelessCommand" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" + "pattern": "^DC[0-9a-fA-F]{32}$" }, "required": true } @@ -5051,25 +5477,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.wireless.command" }, "examples": { - "update": { - "value": { - "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -5119,79 +5542,10 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateHostedNumbersAuthorizationDocument", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateHostedNumbersAuthorizationDocumentRequest", - "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." - }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." - } - } - }, - "examples": { - "update": { - "value": { - "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "Email": "test+hosted@twilio.com", - "CcEmails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "HostedNumberOrderSids": [ - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" - ], - "Status": "signing", - "ContactTitle": "Mr.", - "ContactPhoneNumber": "+14155555555" - } - } - } - } - } - } + "operationId": "FetchWirelessCommand" } }, - "/HostedNumbers/AuthorizationDocuments": { + "/wireless/Commands": { "servers": [ { "url": "https://preview.twilio.com" @@ -5200,52 +5554,75 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "dependent_hosted_number_orders": { - "mapping": { - "signing_document_sid": "sid" - }, - "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" - } - }, "pathType": "list" }, "get": { - "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "description": "", "tags": [ - "PreviewHostedNumbersAuthorizationDocument" + "PreviewWirelessCommand" ], "parameters": [ { - "name": "Email", + "name": "Device", "in": "query", - "description": "Email that this AuthorizationDocument will be sent to for signing.", + "description": "", "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 + "examples": { + "readEmpty": { + "value": "device" + }, + "readFull": { + "value": "device" } + } + }, + { + "name": "Sim", + "in": "query", + "description": "", + "schema": { + "type": "string" }, "examples": { "readEmpty": { - "value": "test+hosted@twilio.com" + "value": "sim" + }, + "readFull": { + "value": "sim" } } }, { "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.", + "description": "", "schema": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status" + "type": "string" }, "examples": { "readEmpty": { - "value": "signed" + "value": "status" + }, + "readFull": { + "value": "status" + } + } + }, + { + "name": "Direction", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "direction" + }, + "readFull": { + "value": "direction" } } }, @@ -5284,10 +5661,10 @@ "schema": { "type": "object", "properties": { - "items": { + "commands": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.wireless.command" } }, "meta": { @@ -5323,52 +5700,49 @@ "type": "object" } }, - "title": "ListHostedNumbersAuthorizationDocumentResponse" + "title": "ListWirelessCommandResponse" }, "examples": { "readEmpty": { "value": { + "commands": [], "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", - "key": "items", + "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", + "key": "commands", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" - }, - "items": [] + "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + } } }, "readFull": { "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", - "key": "items", + "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", + "key": "commands", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" - }, - "items": [ - { - "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ] + "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + } } } } @@ -5418,37 +5792,34 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersAuthorizationDocument" + "operationId": "ListWirelessCommand" }, "post": { - "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "description": "", "tags": [ - "PreviewHostedNumbersAuthorizationDocument" + "PreviewWirelessCommand" ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.wireless.command" }, "examples": { "create": { "value": { - "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -5498,71 +5869,58 @@ "accountSid_authToken": [] } ], - "operationId": "CreateHostedNumbersAuthorizationDocument", + "operationId": "CreateWirelessCommand", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateHostedNumbersAuthorizationDocumentRequest", + "title": "CreateWirelessCommandRequest", "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." + "Command": { + "type": "string", + "description": "" + }, + "Device": { + "type": "string", + "description": "" }, - "AddressSid": { + "Sim": { "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." + "description": "" }, - "Email": { + "CallbackMethod": { "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." + "description": "" }, - "ContactTitle": { + "CallbackUrl": { "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." + "format": "uri", + "description": "" }, - "ContactPhoneNumber": { + "CommandMode": { "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." + "description": "" }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + "IncludeSid": { + "type": "string", + "description": "" } }, "required": [ - "HostedNumberOrderSids", - "AddressSid", - "Email", - "ContactTitle", - "ContactPhoneNumber" + "Command" ] }, "examples": { "create": { "value": { - "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "Email": "test+hosted@twilio.com", - "CcEmails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "HostedNumberOrderSids": [ - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" - ], - "ContactTitle": "Mr.", - "ContactPhoneNumber": "+14155555555" + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "command_mode", + "Device": "device", + "Sim": "sim", + "IncludeSid": "include_sid" } } } @@ -5571,7 +5929,7 @@ } } }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "/wireless/RatePlans": { "servers": [ { "url": "https://preview.twilio.com" @@ -5580,109 +5938,14 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/AuthorizationDocuments/{Sid}", "pathType": "list" }, "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "description": "", "tags": [ - "PreviewHostedNumbersDependentHostedNumberOrder" + "PreviewWirelessRatePlan" ], "parameters": [ - { - "name": "SigningDocumentSid", - "in": "path", - "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" - }, - "examples": { - "readEmpty": { - "value": "completed" - } - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - }, - "examples": { - "readEmpty": { - "value": "+19193608000" - } - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - }, - "examples": { - "readEmpty": { - "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, - "examples": { - "readEmpty": { - "value": "example" - } - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, - "examples": { - "readEmpty": { - "value": "something123" - } - } - }, { "name": "PageSize", "in": "query", @@ -5718,10 +5981,10 @@ "schema": { "type": "object", "properties": { - "items": { + "rate_plans": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + "$ref": "#/components/schemas/preview.wireless.rate_plan" } }, "meta": { @@ -5757,69 +6020,140 @@ "type": "object" } }, - "title": "ListHostedNumbersDependentHostedNumberOrderResponse" + "title": "ListWirelessRatePlanResponse" }, "examples": { "readEmpty": { "value": { "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", - "key": "items", + "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" }, - "items": [] + "rate_plans": [] } }, "readFull": { "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" - }, - "items": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": "1234", - "friendly_name": "friendly_name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "received", - "failure_reason": "", - "unique_name": "foobar", - "verification_attempts": 0, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" - ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" - } - ] + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListWirelessRatePlan" + }, + "post": { + "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -5861,7 +6195,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -5869,10 +6203,85 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersDependentHostedNumberOrder" + "operationId": "CreateWirelessRatePlan", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateWirelessRatePlanRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + }, + "DataEnabled": { + "type": "boolean", + "description": "" + }, + "DataLimit": { + "type": "integer", + "description": "" + }, + "DataMetering": { + "type": "string", + "description": "" + }, + "MessagingEnabled": { + "type": "boolean", + "description": "" + }, + "VoiceEnabled": { + "type": "boolean", + "description": "" + }, + "CommandsEnabled": { + "type": "boolean", + "description": "" + }, + "NationalRoamingEnabled": { + "type": "boolean", + "description": "" + }, + "InternationalRoaming": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "DataEnabled": true, + "DataLimit": 1000, + "DataMetering": "pooled", + "MessagingEnabled": true, + "VoiceEnabled": true, + "FriendlyName": "friendly_name", + "NationalRoamingEnabled": true, + "InternationalRoaming": [ + "data", + "voice", + "messaging" + ], + "Status": "status" + } + } + } + } + } + } } }, - "/HostedNumbers/HostedNumberOrders/{Sid}": { + "/wireless/RatePlans/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -5884,20 +6293,17 @@ "pathType": "instance" }, "get": { - "description": "Fetch a specific HostedNumberOrder.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewWirelessRatePlan" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -5907,43 +6313,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.wireless.rate_plan" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": "5105", - "failure_reason": "", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", "friendly_name": "friendly_name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "received", - "unique_name": "foobar", - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -5993,54 +6385,20 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersHostedNumberOrder" - }, - "delete": { - "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", - "tags": [ - "PreviewHostedNumbersHostedNumberOrder" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteHostedNumbersHostedNumberOrder" + "operationId": "FetchWirelessRatePlan" }, "post": { - "description": "Updates a specific HostedNumberOrder.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewWirelessRatePlan" ], "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}$" + "description": "", + "schema": { + "type": "string" }, "required": true } @@ -6050,43 +6408,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.wireless.rate_plan" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "extension": "1234", - "failure_reason": "", - "friendly_name": "new friendly name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "pending-loa", - "unique_name": "new unique name", - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 1, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -6136,86 +6480,66 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateHostedNumbersHostedNumberOrder", + "operationId": "UpdateWirelessRatePlan", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateHostedNumbersHostedNumberOrderRequest", + "title": "UpdateWirelessRatePlanRequest", "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." + "description": "" }, - "Extension": { + "FriendlyName": { "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." + "description": "" } } }, "examples": { "update": { "value": { - "FriendlyName": "new friendly name", - "UniqueName": "new unique name", - "Email": "test+hosted@twilio.com", - "CcEmails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "Status": "pending-loa", - "Extension": "1234", - "CallDelay": 15 + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" } } } } } } + }, + "delete": { + "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteWirelessRatePlan" } }, - "/HostedNumbers/HostedNumberOrders": { + "/wireless/Sims/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -6224,122 +6548,30 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list" - }, - "get": { - "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", - "tags": [ - "PreviewHostedNumbersHostedNumberOrder" - ], - "parameters": [ - { - "name": "Status", - "in": "query", - "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status" - }, - "examples": { - "readEmpty": { - "value": "completed" - } - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - }, - "examples": { - "readEmpty": { - "value": "+19193608000" - } - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - }, - "examples": { - "readEmpty": { - "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" - } - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, - "examples": { - "readEmpty": { - "value": "example" - } - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } + "dependentProperties": { + "usage": { + "mapping": { + "sim_sid": "sid" }, - "examples": { - "readEmpty": { - "value": "something123" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, + "resource_url": "/wireless/Sims/{sim_sid}/Usage" + } + }, + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "PreviewWirelessSim" + ], + "parameters": [ { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "Sid", + "in": "path", + "description": "", "schema": { "type": "string" - } + }, + "required": true } ], "responses": { @@ -6347,111 +6579,36 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "title": "ListHostedNumbersHostedNumberOrderResponse" + "$ref": "#/components/schemas/preview.wireless.sim" }, "examples": { - "readEmpty": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" - }, - "items": [] - } - }, - "readFull": { + "fetch": { "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, - "items": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": "1234", - "failure_reason": "", - "friendly_name": "friendly_name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "received", - "unique_name": "foobar", - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" - ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" - } - ] + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -6501,109 +6658,59 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersHostedNumberOrder" + "operationId": "FetchWirelessSim" }, "post": { - "description": "Host a phone number's capability on Twilio's platform.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewWirelessSim" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.wireless.sim" }, "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 0, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": null, - "failure_reason": "", - "friendly_name": null, - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": null, - "status": "received", - "unique_name": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": null, - "verification_code": null, - "verification_document_sid": null, - "verification_type": "phone-call" - } - }, - "createWithoutOptionalLoaFields": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": null, - "call_delay": 0, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": null, - "extension": null, - "failure_reason": "", - "friendly_name": null, - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": null, - "status": "received", - "unique_name": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": null, - "verification_code": null, - "verification_document_sid": null, - "verification_type": "phone-call" - } - }, - "createWithPhoneBillVerification": { + "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": null, - "call_delay": 0, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": null, - "extension": null, - "failure_reason": "", - "friendly_name": null, - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": null, - "status": "received", - "unique_name": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": null, - "verification_code": null, - "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_type": "phone-bill" + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -6645,7 +6752,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -6653,63 +6760,52 @@ "accountSid_authToken": [] } ], - "operationId": "CreateHostedNumbersHostedNumberOrder", + "operationId": "UpdateWirelessSim", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateHostedNumbersHostedNumberOrderRequest", + "title": "UpdateWirelessSimRequest", "properties": { - "PhoneNumber": { + "UniqueName": { "type": "string", - "format": "phone-number", - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + "description": "" }, - "SmsCapability": { - "type": "boolean", - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + "CallbackMethod": { + "type": "string", + "description": "" }, - "AccountSid": { + "CallbackUrl": { "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." + "format": "uri", + "description": "" }, "FriendlyName": { "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." + "description": "" }, - "UniqueName": { + "RatePlan": { "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." + "description": "" }, - "SmsUrl": { + "Status": { "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." + "description": "" }, - "SmsMethod": { + "CommandsCallbackMethod": { "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." + "description": "" }, - "SmsFallbackUrl": { + "CommandsCallbackUrl": { "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." + "description": "" }, "SmsFallbackMethod": { "type": "string", @@ -6718,207 +6814,85 @@ "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." + "description": "" }, - "StatusCallbackUrl": { + "SmsFallbackUrl": { "type": "string", "format": "uri", - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + "description": "" }, - "StatusCallbackMethod": { + "SmsMethod": { "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." + "description": "" }, - "AddressSid": { + "SmsUrl": { "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." + "format": "uri", + "description": "" }, - "Email": { + "VoiceFallbackMethod": { "type": "string", - "description": "Optional. Email of the owner of this phone number that is being hosted." + "format": "http-method", + "enum": [ + "GET", + "POST" + ], + "description": "" }, - "VerificationType": { + "VoiceFallbackUrl": { "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." + "format": "uri", + "description": "" }, - "VerificationDocumentSid": { + "VoiceMethod": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." - } - }, - "required": [ - "PhoneNumber", - "SmsCapability" - ] - }, - "examples": { - "create": { - "value": { - "AddressSid": "AD11111111111111111111111111111111", - "PhoneNumber": "+14153608311", - "SmsCapability": true, - "Email": "test@twilio.com" - } - }, - "createWithoutOptionalLoaFields": { - "value": { - "PhoneNumber": "+14153608311", - "SmsCapability": true - } - }, - "createWithPhoneBillVerification": { - "value": { - "PhoneNumber": "+14153608311", - "SmsCapability": true, - "VerificationType": "phone-bill", - "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - } - }, - "/marketplace/AvailableAddOns/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "available_add_on_sid": "sid" - }, - "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" - } - }, - "pathType": "instance" - }, - "get": { - "description": "Fetch an instance of an Add-on currently available to be installed.", - "tags": [ - "PreviewMarketplaceAvailableAddOn" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The SID of the AvailableAddOn resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" - }, - "examples": { - "fetch": { - "value": { - "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "pricing_type": "per minute", - "configuration_schema": { - "type": "object", - "properties": { - "bad_words": { - "type": "boolean" - } - }, - "required": [ - "bad_words" - ] - }, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" - } - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" + "format": "http-method", + "enum": [ + "GET", + "POST" + ], + "description": "" + }, + "VoiceUrl": { + "type": "string", + "format": "uri", + "description": "" + } } }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "CommandsCallbackMethod": "http_method", + "CommandsCallbackUrl": "http://www.example.com", + "VoiceMethod": "http_method", + "VoiceUrl": "http://www.example.com", + "VoiceFallbackMethod": "http_method", + "VoiceFallbackUrl": "http://www.example.com", + "SmsMethod": "http_method", + "SmsUrl": "http://www.example.com", + "SmsFallbackMethod": "http_method", + "SmsFallbackUrl": "http://www.example.com", + "FriendlyName": "friendly_name", + "RatePlan": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Status": "status" + } } } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] + } } - ], - "operationId": "FetchMarketplaceAvailableAddOn" + } } }, - "/marketplace/AvailableAddOns": { + "/wireless/Sims": { "servers": [ { "url": "https://preview.twilio.com" @@ -6928,21 +6902,85 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "extensions": { + "usage": { "mapping": { - "available_add_on_sid": "sid" + "sim_sid": "sid" }, - "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + "resource_url": "/wireless/Sims/{sim_sid}/Usage" } }, "pathType": "list" }, "get": { - "description": "Retrieve a list of Add-ons currently available to be installed.", + "description": "", "tags": [ - "PreviewMarketplaceAvailableAddOn" + "PreviewWirelessSim" ], "parameters": [ + { + "name": "Status", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } + } + }, + { + "name": "Iccid", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } + } + }, + { + "name": "RatePlan", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "rate_plan" + }, + "readFull": { + "value": "rate_plan" + } + } + }, + { + "name": "EId", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + }, + { + "name": "SimRegistrationCode", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -6978,10 +7016,10 @@ "schema": { "type": "object", "properties": { - "available_add_ons": { + "sims": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" + "$ref": "#/components/schemas/preview.wireless.sim" } }, "meta": { @@ -7017,57 +7055,188 @@ "type": "object" } }, - "title": "ListMarketplaceAvailableAddOnResponse" + "title": "ListWirelessSimResponse" + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "sims": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListWirelessSim" + } + }, + "/wireless/Sims/{SimSid}/Usage": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Sims/{Sid}", + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "PreviewWirelessUsage" + ], + "parameters": [ + { + "name": "SimSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "End", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "fetch": { + "value": "end" + } + } + }, + { + "name": "Start", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "fetch": { + "value": "start" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim.usage" }, "examples": { - "readFull": { - "value": { - "available_add_ons": [ - { - "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "pricing_type": "per minute", - "configuration_schema": { - "type": "object", - "properties": { - "bad_words": { - "type": "boolean" - } - }, - "required": [ - "bad_words" - ] - }, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" - } - } - ], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "available_add_ons" - } - } - }, - "readEmpty": { + "fetch": { "value": { - "available_add_ons": [], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "available_add_ons" - } + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands_costs": {}, + "commands_usage": {}, + "data_costs": {}, + "data_usage": {}, + "sim_unique_name": "sim_unique_name", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": {}, + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage" } } } @@ -7117,10 +7286,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOn" + "operationId": "FetchWirelessUsage" } }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -7129,37 +7298,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension", + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "Fetch an instance of an Extension for the Available Add-on.", + "description": "Fetch information about a specific Certificate credential in the Fleet.", "tags": [ - "PreviewMarketplaceAvailableAddOnExtension" + "PreviewDeployedDevicesCertificate" ], "parameters": [ { - "name": "AvailableAddOnSid", + "name": "FleetSid", "in": "path", - "description": "The SID of the AvailableAddOn resource with the extension to fetch.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "The SID of the AvailableAddOn Extension resource to fetch.", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } @@ -7169,17 +7334,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" }, "examples": { "fetch": { "value": { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7229,152 +7397,95 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOnExtension" - } - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension", - "pathType": "list" + "operationId": "FetchDeployedDevicesCertificate" }, - "get": { - "description": "Retrieve a list of Extensions for the Available Add-on.", + "delete": { + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "tags": [ - "PreviewMarketplaceAvailableAddOnExtension" + "PreviewDeployedDevicesCertificate" ], "parameters": [ { - "name": "AvailableAddOnSid", + "name": "FleetSid", "in": "path", - "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" + "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.", + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "extensions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "title": "ListMarketplaceAvailableAddOnExtensionResponse" + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesCertificate" + }, + "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" }, "examples": { - "readFull": { - "value": { - "extensions": [ - { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" - } - } - }, - "readEmpty": { + "update": { "value": { - "extensions": [], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" - } + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7424,10 +7535,41 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOnExtension" + "operationId": "UpdateDeployedDevicesCertificate", + "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." + } + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } + } + } + } + } } }, - "/marketplace/InstalledAddOns": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { "servers": [ { "url": "https://preview.twilio.com" @@ -7436,52 +7578,44 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" - }, - "usage": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" - } - }, + "parent": "/Fleets/{Sid}", "pathType": "list" }, "post": { - "description": "Install an Add-on for the Account specified.", + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "PreviewDeployedDevicesCertificate" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" }, "examples": { "create": { "value": { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription_1", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7531,45 +7665,40 @@ "accountSid_authToken": [] } ], - "operationId": "CreateMarketplaceInstalledAddOn", + "operationId": "CreateDeployedDevicesCertificate", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateMarketplaceInstalledAddOnRequest", + "title": "CreateDeployedDevicesCertificateRequest", "properties": { - "AvailableAddOnSid": { + "CertificateData": { "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." + "description": "Provides a URL encoded representation of the public certificate in PEM format." }, - "Configuration": { - "description": "The JSON object that represents the configuration of the new Add-on being installed." + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." }, - "UniqueName": { + "DeviceSid": { "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + "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": [ - "AvailableAddOnSid", - "AcceptTermsOfService" + "CertificateData" ] }, "examples": { "create": { "value": { - "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "AcceptTermsOfService": true, - "Configuration": "{\"bad_words\": true}", - "UniqueName": "voicebase_high_accuracy_transcription_1" + "CertificateData": "12345678abcdef", + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } @@ -7578,11 +7707,31 @@ } }, "get": { - "description": "Retrieve a list of Add-ons currently installed on this Account.", + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "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", @@ -7618,10 +7767,10 @@ "schema": { "type": "object", "properties": { - "installed_add_ons": { + "certificates": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } }, "meta": { @@ -7657,52 +7806,46 @@ "type": "object" } }, - "title": "ListMarketplaceInstalledAddOnResponse" + "title": "ListDeployedDevicesCertificateResponse" }, "examples": { - "readFull": { + "readEmpty": { "value": { - "installed_add_ons": [ - { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - ], + "certificates": [], "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, "page": 0, "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "installed_add_ons" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" } } }, - "readEmpty": { + "readFull": { "value": { - "installed_add_ons": [], + "certificates": [ + { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, "page": 0, "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "installed_add_ons" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" } } } @@ -7753,10 +7896,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOn" + "operationId": "ListDeployedDevicesCertificate" } }, - "/marketplace/InstalledAddOns/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -7765,68 +7908,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" - }, - "usage": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" - } - }, + "parent": "/Fleets/{Sid}", "pathType": "instance" }, - "delete": { - "description": "Remove an Add-on installation from your account", + "get": { + "description": "Fetch information about a specific Deployment in the Fleet.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "Sid", + "name": "FleetSid", "in": "path", - "description": "The SID of the InstalledAddOn resource to delete.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteMarketplaceInstalledAddOn" - }, - "get": { - "description": "Fetch an instance of an Add-on currently installed on this Account.", - "tags": [ - "PreviewMarketplaceInstalledAddOn" - ], - "parameters": [ + }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn resource to fetch.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -7836,26 +7944,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" }, "examples": { "fetch": { "value": { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7905,94 +8006,39 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOn" + "operationId": "FetchDeployedDevicesDeployment" }, - "post": { - "description": "Update an Add-on installation for the Account specified.", + "delete": { + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "PreviewDeployedDevicesDeployment" ], "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn resource to update.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - }, - "examples": { - "update": { - "value": { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription_2", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -8000,76 +8046,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateMarketplaceInstalledAddOn", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateMarketplaceInstalledAddOnRequest", - "properties": { - "Configuration": { - "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." - } - } - }, - "examples": { - "update": { - "value": { - "Configuration": "{\"bad_words\": true}", - "UniqueName": "voicebase_high_accuracy_transcription_2" - } - } - } - } - } - } - } - }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension", - "pathType": "instance" + "operationId": "DeleteDeployedDevicesDeployment" }, - "get": { - "description": "Fetch an instance of an Extension for the Installed Add-on.", + "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": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "InstalledAddOnSid", + "name": "FleetSid", "in": "path", - "description": "The SID of the InstalledAddOn resource with the extension to fetch.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -8079,18 +8081,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" }, "examples": { - "fetch": { + "update": { "value": { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "enabled": true, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -8140,56 +8143,86 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOnExtension" + "operationId": "UpdateDeployedDevicesDeployment", + "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." + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Fleets/{Sid}", + "pathType": "list" }, "post": { - "description": "Update an Extension for an Add-on installation.", + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewDeployedDevicesDeployment" ], "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", + "name": "FleetSid", "in": "path", - "description": "The SID of the InstalledAddOn Extension resource to update.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" }, "examples": { - "update": { + "create": { "value": { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "enabled": false, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -8231,7 +8264,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -8239,63 +8272,51 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateMarketplaceInstalledAddOnExtension", + "operationId": "CreateDeployedDevicesDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", + "title": "CreateDeployedDevicesDeploymentRequest", "properties": { - "Enabled": { - "type": "boolean", - "description": "Whether the Extension should be invoked." + "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." } - }, - "required": [ - "Enabled" - ] + } }, "examples": { - "update": { + "create": { "value": { - "Enabled": false + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" } } } } } } - } - }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension", - "pathType": "list" }, "get": { - "description": "Retrieve a list of Extensions for the Installed Add-on.", + "description": "Retrieve a list of all Deployments belonging to the Fleet.", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "InstalledAddOnSid", + "name": "FleetSid", "in": "path", - "description": "The SID of the InstalledAddOn resource with the extensions to read.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, @@ -8334,10 +8355,10 @@ "schema": { "type": "object", "properties": { - "extensions": { + "deployments": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } }, "meta": { @@ -8373,44 +8394,45 @@ "type": "object" } }, - "title": "ListMarketplaceInstalledAddOnExtensionResponse" + "title": "ListDeployedDevicesDeploymentResponse" }, "examples": { - "readFull": { + "readEmpty": { "value": { - "extensions": [ - { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "enabled": true, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], + "deployments": [], "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, "page": 0, "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" } } }, - "readEmpty": { + "readFull": { "value": { - "extensions": [], + "deployments": [ + { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, "page": 0, "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" } } } @@ -8461,10 +8483,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOnExtension" + "operationId": "ListDeployedDevicesDeployment" } }, - "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -8473,40 +8495,28 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "permissions": { - "mapping": { - "service_sid": "service_sid", - "document_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Device in the Fleet.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -8518,35 +8528,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" }, "examples": { "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { - "ETag": { - "schema": { - "type": "string" - } - }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -8590,30 +8594,27 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocument" + "operationId": "FetchDeployedDevicesDevice" }, "delete": { - "description": "", + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -8630,42 +8631,31 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocument" + "operationId": "DeleteDeployedDevicesDevice" }, "post": { - "description": "", + "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": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -8673,35 +8663,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" }, "examples": { "update": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { - "ETag": { - "schema": { - "type": "string" - } - }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -8745,27 +8729,40 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocument", + "operationId": "UpdateDeployedDevicesDevice", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncDocumentRequest", + "title": "UpdateDeployedDevicesDeviceRequest", "properties": { - "Data": { + "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": "" } - }, - "required": [ - "Data" - ] + } }, "examples": { "update": { "value": { - "Data": "{}", - "UniqueName": "unique_name" + "FriendlyName": "friendly_name", + "Identity": "identity" } } } @@ -8774,7 +8771,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Documents": { + "/DeployedDevices/Fleets/{FleetSid}/Devices": { "servers": [ { "url": "https://preview.twilio.com" @@ -8783,33 +8780,21 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "permissions": { - "mapping": { - "service_sid": "service_sid", - "document_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", + "parent": "/Fleets/{Sid}", "pathType": "list" }, "post": { - "description": "", + "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": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -8819,35 +8804,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" }, "examples": { "create": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { - "ETag": { - "schema": { - "type": "string" - } - }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -8891,19 +8870,35 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncDocument", + "operationId": "CreateDeployedDevicesDevice", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncDocumentRequest", + "title": "CreateDeployedDevicesDeviceRequest", "properties": { "UniqueName": { "type": "string", - "description": "" + "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." }, - "Data": { + "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": "" } } @@ -8911,8 +8906,9 @@ "examples": { "create": { "value": { - "Data": "{}", - "UniqueName": "unique_name" + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Identity": "identity" } } } @@ -8921,22 +8917,30 @@ } }, "get": { - "description": "", + "description": "Retrieve a list of all Devices belonging to the Fleet.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "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": "^IS[0-9a-fA-F]{32}$" - }, - "required": true + "pattern": "^DL[0-9a-fA-F]{32}$" + } }, { "name": "PageSize", @@ -8973,10 +8977,10 @@ "schema": { "type": "object", "properties": { - "documents": { + "devices": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } }, "meta": { @@ -9012,50 +9016,49 @@ "type": "object" } }, - "title": "ListSyncDocumentResponse" + "title": "ListDeployedDevicesDeviceResponse" }, "examples": { "readEmpty": { "value": { - "documents": [], + "devices": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", - "key": "documents", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" } } }, "readFull": { "value": { - "documents": [ + "devices": [ { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", - "key": "documents", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" } } } @@ -9106,10 +9109,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocument" + "operationId": "ListDeployedDevicesDevice" } }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { + "/DeployedDevices/Fleets/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -9118,41 +9121,163 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions", + "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" + } + }, "pathType": "instance" }, "get": { - "description": "Fetch a specific Sync Document Permission.", + "description": "Fetch information about a specific Fleet in your account.", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewDeployedDevicesFleet" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "examples": { + "fetch": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "name": "DocumentSid", + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeployedDevicesFleet" + }, + "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": "Identifier of the Sync Document. Either a SID or a unique name.", + "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": [ { - "name": "Identity", + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesFleet" + }, + "post": { + "description": "Update the friendly name property of a specific Fleet in your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "parameters": [ + { + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { "type": "string" }, @@ -9164,19 +9289,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" }, "examples": { - "fetch": { + "update": { "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } } } } @@ -9226,112 +9357,106 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocumentPermission" - }, - "delete": { - "description": "Delete a specific Sync Document Permission.", - "tags": [ - "PreviewSyncDocumentPermission" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "operationId": "UpdateDeployedDevicesFleet", + "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." + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "DefaultDeploymentSid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "devices": { + "mapping": { + "fleet_sid": "sid" }, - "required": true + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" }, - { - "name": "DocumentSid", - "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "schema": { - "type": "string" + "deployments": { + "mapping": { + "fleet_sid": "sid" }, - "required": true + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" + "certificates": { + "mapping": { + "fleet_sid": "sid" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncDocumentPermission" + "pathType": "list" }, "post": { - "description": "Update an identity's access to a specific Sync Document.", + "description": "Create a new Fleet for scoping of deployed devices within your account.", "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 - } + "PreviewDeployedDevicesFleet" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" }, "examples": { - "update": { + "create": { "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } } } } @@ -9373,7 +9498,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -9381,87 +9506,37 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocumentPermission", + "operationId": "CreateDeployedDevicesFleet", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncDocumentPermissionRequest", + "title": "CreateDeployedDevicesFleetRequest", "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." + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } }, "examples": { - "update": { + "create": { "value": { - "Read": "true", - "Write": "true", - "Manage": "true" + "FriendlyName": "friendly_name" } } } } } } - } - }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions", - "pathType": "list" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Document.", + "description": "Retrieve a list of all Fleets belonging to your account.", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewDeployedDevicesFleet" ], "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", @@ -9497,10 +9572,10 @@ "schema": { "type": "object", "properties": { - "permissions": { + "fleets": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" } }, "meta": { @@ -9536,45 +9611,51 @@ "type": "object" } }, - "title": "ListSyncDocumentPermissionResponse" + "title": "ListDeployedDevicesFleetResponse" }, "examples": { "readEmpty": { "value": { - "permissions": [], + "fleets": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" } } }, "readFull": { "value": { - "permissions": [ + "fleets": [ { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" } } } @@ -9625,10 +9706,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission" + "operationId": "ListDeployedDevicesFleet" } }, - "/Sync/Services/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -9637,43 +9718,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "documents": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents" - }, - "lists": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists" - }, - "maps": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps" - } - }, + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Key credential in the Fleet.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "Sid", + "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": "^IS[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -9683,25 +9754,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" }, "examples": { "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "friendly_name", - "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": false + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9751,23 +9817,32 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncService" + "operationId": "FetchDeployedDevicesKey" }, "delete": { - "description": "", + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "Sid", + "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": "^IS[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -9782,23 +9857,32 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncService" + "operationId": "DeleteDeployedDevicesKey" }, "post": { - "description": "", + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "Sid", + "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": "^IS[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -9808,25 +9892,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" }, "examples": { "update": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "friendly_name", - "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": true + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9876,39 +9955,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncService", + "operationId": "UpdateDeployedDevicesKey", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncServiceRequest", + "title": "UpdateDeployedDevicesKeyRequest", "properties": { - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, "FriendlyName": { "type": "string", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." }, - "AclEnabled": { - "type": "boolean", - "description": "" + "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." } } }, "examples": { "update": { "value": { - "FriendlyName": "friendly_name", - "WebhookUrl": "http://www.example.com", - "AclEnabled": true + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } @@ -9917,7 +9989,7 @@ } } }, - "/Sync/Services": { + "/DeployedDevices/Fleets/{FleetSid}/Keys": { "servers": [ { "url": "https://preview.twilio.com" @@ -9926,57 +9998,44 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "documents": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents" - }, - "lists": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists" - }, - "maps": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps" - } - }, + "parent": "/Fleets/{Sid}", "pathType": "list" }, "post": { - "description": "", + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesKey" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" }, "examples": { "create": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "friendly_name", - "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": true + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -10026,39 +10085,32 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncService", + "operationId": "CreateDeployedDevicesKey", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncServiceRequest", + "title": "CreateDeployedDevicesKeyRequest", "properties": { "FriendlyName": { "type": "string", - "description": "" + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." }, - "WebhookUrl": { + "DeviceSid": { "type": "string", - "format": "uri", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" - }, - "AclEnabled": { - "type": "boolean", - "description": "" + "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." } } }, "examples": { "create": { "value": { - "FriendlyName": "friendly_name", - "WebhookUrl": "http://www.example.com", - "AclEnabled": true + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } @@ -10067,11 +10119,31 @@ } }, "get": { - "description": "", + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", "tags": [ - "PreviewSyncService" + "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", @@ -10107,10 +10179,10 @@ "schema": { "type": "object", "properties": { - "services": { + "keys": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } }, "meta": { @@ -10146,52 +10218,47 @@ "type": "object" } }, - "title": "ListSyncServiceResponse" + "title": "ListDeployedDevicesKeyResponse" }, "examples": { "readEmpty": { "value": { + "keys": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", - "key": "services", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" - }, - "services": [] + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + } } }, "readFull": { "value": { + "keys": [ + { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", - "key": "services", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" - }, - "services": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": false - } - ] + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + } } } } @@ -10241,10 +10308,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncService" + "operationId": "ListDeployedDevicesKey" } }, - "/Sync/Services/{ServiceSid}/Lists/{Sid}": { + "/Sync/Services/{ServiceSid}/Documents/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -10254,29 +10321,21 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "items": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" - }, "permissions": { "mapping": { "service_sid": "service_sid", - "list_sid": "sid" + "document_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewSyncDocument" ], "parameters": [ { @@ -10306,30 +10365,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } } } } } }, "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -10373,12 +10437,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList" + "operationId": "FetchSyncDocument" }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewSyncDocument" ], "parameters": [ { @@ -10413,10 +10477,151 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncList" + "operationId": "DeleteSyncDocument" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncDocument" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } + } + } + }, + "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateSyncDocument", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateSyncDocumentRequest", + "properties": { + "Data": { + "description": "" + } + }, + "required": [ + "Data" + ] + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" + } + } + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Lists": { + "/Sync/Services/{ServiceSid}/Documents": { "servers": [ { "url": "https://preview.twilio.com" @@ -10426,29 +10631,21 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "items": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" - }, "permissions": { "mapping": { "service_sid": "service_sid", - "list_sid": "sid" + "document_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists", "pathType": "list" }, "post": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewSyncDocument" ], "parameters": [ { @@ -10469,30 +10666,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } } } } } }, "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -10536,23 +10738,27 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncList", + "operationId": "CreateSyncDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListRequest", + "title": "CreateSyncDocumentRequest", "properties": { "UniqueName": { "type": "string", "description": "" + }, + "Data": { + "description": "" } } }, "examples": { "create": { "value": { + "Data": "{}", "UniqueName": "unique_name" } } @@ -10564,7 +10770,7 @@ "get": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewSyncDocument" ], "parameters": [ { @@ -10614,10 +10820,10 @@ "schema": { "type": "object", "properties": { - "lists": { + "documents": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.sync.service.document" } }, "meta": { @@ -10653,50 +10859,50 @@ "type": "object" } }, - "title": "ListSyncSyncListResponse" + "title": "ListSyncDocumentResponse" }, "examples": { "readEmpty": { "value": { - "lists": [], + "documents": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", - "key": "lists", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } }, "readFull": { "value": { - "lists": [ + "documents": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", - "key": "lists", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } } @@ -10747,10 +10953,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncList" + "operationId": "ListSyncDocument" } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -10759,127 +10965,14 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items", + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions", "pathType": "instance" }, "get": { - "description": "", - "tags": [ - "PreviewSyncSyncListItem" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Index", - "in": "path", - "description": "", - "schema": { - "type": "integer" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" - } - } - } - } - }, - "headers": { - "ETag": { - "schema": { - "type": "string" - } - }, - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSyncSyncListItem" - }, - "delete": { - "description": "", + "description": "Fetch a specific Sync Document Permission.", "tags": [ - "PreviewSyncSyncListItem" + "PreviewSyncDocumentPermission" ], "parameters": [ { @@ -10895,87 +10988,22 @@ "required": true }, { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Index", + "name": "DocumentSid", "in": "path", - "description": "", - "schema": { - "type": "integer" - }, - "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncListItem" - }, - "post": { - "description": "", - "tags": [ - "PreviewSyncSyncListItem" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "ListSid", + "name": "Identity", "in": "path", - "description": "", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "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": { @@ -10983,32 +11011,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" }, "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { - "ETag": { - "schema": { - "type": "string" - } - }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -11052,57 +11073,67 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListItem", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncSyncListItemRequest", - "properties": { - "Data": { - "description": "" - } - }, - "required": [ - "Data" - ] - }, - "examples": { - "update": { - "value": { - "Data": "{}" - } - } - } - } + "operationId": "FetchSyncDocumentPermission" + }, + "delete": { + "description": "Delete a specific Sync Document Permission.", + "tags": [ + "PreviewSyncDocumentPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "DocumentSid", + "in": "path", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true } - } - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items", - "pathType": "list" + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncDocumentPermission" }, "post": { - "description": "", + "description": "Update an identity's access to a specific Sync Document.", "tags": [ - "PreviewSyncSyncListItem" + "PreviewSyncDocumentPermission" ], "parameters": [ { "name": "ServiceSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Sync Service Instance.", "schema": { "type": "string", "minLength": 34, @@ -11112,9 +11143,18 @@ "required": true }, { - "name": "ListSid", + "name": "DocumentSid", "in": "path", - "description": "", + "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" }, @@ -11122,36 +11162,29 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" }, "examples": { - "create": { + "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, "headers": { - "ETag": { - "schema": { - "type": "string" - } - }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -11187,7 +11220,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -11195,37 +11228,64 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncListItem", + "operationId": "UpdateSyncDocumentPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListItemRequest", + "title": "UpdateSyncDocumentPermissionRequest", "properties": { - "Data": { - "description": "" + "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": [ - "Data" + "Read", + "Write", + "Manage" ] }, "examples": { - "create": { + "update": { "value": { - "Data": "{}" + "Read": "true", + "Write": "true", + "Manage": "true" } } } } } } + } + }, + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync Document.", "tags": [ - "PreviewSyncSyncListItem" + "PreviewSyncDocumentPermission" ], "parameters": [ { @@ -11241,64 +11301,14 @@ "required": true }, { - "name": "ListSid", + "name": "DocumentSid", "in": "path", - "description": "", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, - { - "name": "Order", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" - }, - "examples": { - "readEmpty": { - "value": "asc" - }, - "readFull": { - "value": "asc" - } - } - }, - { - "name": "From", - "in": "query", - "description": "", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "from" - }, - "readFull": { - "value": "from" - } - } - }, - { - "name": "Bounds", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" - }, - "examples": { - "readEmpty": { - "value": "inclusive" - }, - "readFull": { - "value": "inclusive" - } - } - }, { "name": "PageSize", "in": "query", @@ -11334,10 +11344,10 @@ "schema": { "type": "object", "properties": { - "items": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } }, "meta": { @@ -11373,47 +11383,45 @@ "type": "object" } }, - "title": "ListSyncSyncListItemResponse" + "title": "ListSyncDocumentPermissionResponse" }, "examples": { "readEmpty": { "value": { - "items": [], + "permissions": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", - "key": "items", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { - "items": [ + "permissions": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", - "key": "items", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -11464,10 +11472,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListItem" + "operationId": "ListSyncDocumentPermission" } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "/Sync/Services/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -11476,18 +11484,36 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions", + "dependentProperties": { + "documents": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents" + }, + "lists": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists" + }, + "maps": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps" + } + }, "pathType": "instance" }, "get": { - "description": "Fetch a specific Sync List Permission.", + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewSyncService" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", "description": "", "schema": { @@ -11497,24 +11523,6 @@ "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": { @@ -11522,19 +11530,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.sync.service" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false } } } @@ -11584,16 +11598,47 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListPermission" + "operationId": "FetchSyncService" }, "delete": { - "description": "Delete a specific Sync List Permission.", + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewSyncService" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncService" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncService" + ], + "parameters": [ + { + "name": "Sid", "in": "path", "description": "", "schema": { @@ -11602,94 +11647,183 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, - "required": true + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateSyncService", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateSyncServiceRequest", + "properties": { + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } + } + } + } + } + } + }, + "/Sync/Services": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "documents": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents" }, - { - "name": "ListSid", - "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "schema": { - "type": "string" + "lists": { + "mapping": { + "service_sid": "sid" }, - "required": true + "resource_url": "/Sync/Services/{service_sid}/Lists" }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" + "maps": { + "mapping": { + "service_sid": "sid" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "resource_url": "/Sync/Services/{service_sid}/Maps" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncListPermission" + "pathType": "list" }, "post": { - "description": "Update an identity's access to a specific Sync List.", + "description": "", "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 - } + "PreviewSyncService" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.sync.service" }, "examples": { - "update": { + "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true } } } @@ -11731,7 +11865,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -11739,87 +11873,52 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListPermission", + "operationId": "CreateSyncService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncListPermissionRequest", + "title": "CreateSyncServiceRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync List." + "FriendlyName": { + "type": "string", + "description": "" }, - "Write": { + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "ReachabilityWebhooksEnabled": { "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." + "description": "" }, - "Manage": { + "AclEnabled": { "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync List." + "description": "" } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } }, "examples": { - "update": { + "create": { "value": { - "Read": "true", - "Write": "true", - "Manage": "true" + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true } } } } } } - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions", - "pathType": "list" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync List.", + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewSyncService" ], "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", @@ -11855,10 +11954,10 @@ "schema": { "type": "object", "properties": { - "permissions": { + "services": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.sync.service" } }, "meta": { @@ -11894,46 +11993,52 @@ "type": "object" } }, - "title": "ListSyncSyncListPermissionResponse" + "title": "ListSyncServiceResponse" }, "examples": { "readEmpty": { "value": { - "permissions": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" + }, + "services": [] } }, "readFull": { "value": { - "permissions": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" - } - ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false + } + ] } } } @@ -11983,10 +12088,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListPermission" + "operationId": "ListSyncService" } }, - "/Sync/Services/{ServiceSid}/Maps/{Sid}": { + "/Sync/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -11999,26 +12104,26 @@ "items": { "mapping": { "service_sid": "service_sid", - "map_sid": "sid" + "list_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", - "map_sid": "sid" + "list_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps", + "mountName": "sync_lists", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewSyncSyncList" ], "parameters": [ { @@ -12048,7 +12153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.sync.service.sync_list" }, "examples": { "fetch": { @@ -12058,14 +12163,14 @@ "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -12115,12 +12220,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMap" + "operationId": "FetchSyncSyncList" }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewSyncSyncList" ], "parameters": [ { @@ -12155,10 +12260,10 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMap" + "operationId": "DeleteSyncSyncList" } }, - "/Sync/Services/{ServiceSid}/Maps": { + "/Sync/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://preview.twilio.com" @@ -12171,26 +12276,26 @@ "items": { "mapping": { "service_sid": "service_sid", - "map_sid": "sid" + "list_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" }, "permissions": { "mapping": { "service_sid": "service_sid", - "map_sid": "sid" + "list_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps", + "mountName": "sync_lists", "pathType": "list" }, "post": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewSyncSyncList" ], "parameters": [ { @@ -12211,7 +12316,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.sync.service.sync_list" }, "examples": { "create": { @@ -12221,14 +12326,14 @@ "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -12278,13 +12383,13 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncMap", + "operationId": "CreateSyncSyncList", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncMapRequest", + "title": "CreateSyncSyncListRequest", "properties": { "UniqueName": { "type": "string", @@ -12306,7 +12411,7 @@ "get": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewSyncSyncList" ], "parameters": [ { @@ -12356,10 +12461,10 @@ "schema": { "type": "object", "properties": { - "maps": { + "lists": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.sync.service.sync_list" } }, "meta": { @@ -12395,50 +12500,50 @@ "type": "object" } }, - "title": "ListSyncSyncMapResponse" + "title": "ListSyncSyncListResponse" }, "examples": { "readEmpty": { "value": { - "maps": [], + "lists": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", - "key": "maps", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } }, "readFull": { "value": { - "maps": [ + "lists": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" }, "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", - "key": "maps", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } } @@ -12489,10 +12594,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMap" + "operationId": "ListSyncSyncList" } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { "servers": [ { "url": "https://preview.twilio.com" @@ -12501,14 +12606,14 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12524,7 +12629,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12533,11 +12638,11 @@ "required": true }, { - "name": "Key", + "name": "Index", "in": "path", "description": "", "schema": { - "type": "string" + "type": "integer" }, "required": true } @@ -12547,7 +12652,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { "fetch": { @@ -12557,11 +12662,11 @@ "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } @@ -12616,12 +12721,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem" + "operationId": "FetchSyncSyncListItem" }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12637,7 +12742,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12646,11 +12751,11 @@ "required": true }, { - "name": "Key", + "name": "Index", "in": "path", "description": "", "schema": { - "type": "string" + "type": "integer" }, "required": true }, @@ -12673,12 +12778,12 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapItem" + "operationId": "DeleteSyncSyncListItem" }, "post": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12694,7 +12799,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12703,11 +12808,11 @@ "required": true }, { - "name": "Key", + "name": "Index", "in": "path", "description": "", "schema": { - "type": "string" + "type": "integer" }, "required": true }, @@ -12725,7 +12830,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { "update": { @@ -12735,11 +12840,11 @@ "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } @@ -12794,13 +12899,13 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapItem", + "operationId": "UpdateSyncSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapItemRequest", + "title": "UpdateSyncSyncListItemRequest", "properties": { "Data": { "description": "" @@ -12822,7 +12927,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" @@ -12831,14 +12936,14 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items", "pathType": "list" }, "post": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12854,7 +12959,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12868,7 +12973,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { "create": { @@ -12878,11 +12983,11 @@ "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } @@ -12937,32 +13042,26 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncMapItem", + "operationId": "CreateSyncSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncMapItemRequest", + "title": "CreateSyncSyncListItemRequest", "properties": { - "Key": { - "type": "string", - "description": "" - }, "Data": { "description": "" } }, "required": [ - "Key", "Data" ] }, "examples": { "create": { "value": { - "Data": "{}", - "Key": "key" + "Data": "{}" } } } @@ -12973,7 +13072,7 @@ "get": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12989,7 +13088,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -13003,7 +13102,7 @@ "description": "", "schema": { "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" }, "examples": { "readEmpty": { @@ -13036,7 +13135,7 @@ "description": "", "schema": { "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" }, "examples": { "readEmpty": { @@ -13085,7 +13184,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } }, "meta": { @@ -13121,20 +13220,20 @@ "type": "object" } }, - "title": "ListSyncSyncMapItemResponse" + "title": "ListSyncSyncListItemResponse" }, "examples": { "readEmpty": { "value": { "items": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } }, @@ -13147,21 +13246,21 @@ "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "revision": "revision", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -13212,10 +13311,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapItem" + "operationId": "ListSyncSyncListItem" } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -13224,14 +13323,14 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions", "pathType": "instance" }, "get": { - "description": "Fetch a specific Sync Map Permission.", + "description": "Fetch a specific Sync List Permission.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewSyncSyncListPermission" ], "parameters": [ { @@ -13247,9 +13346,9 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, @@ -13270,19 +13369,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -13332,12 +13431,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapPermission" + "operationId": "FetchSyncSyncListPermission" }, "delete": { - "description": "Delete a specific Sync Map Permission.", + "description": "Delete a specific Sync List Permission.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewSyncSyncListPermission" ], "parameters": [ { @@ -13353,9 +13452,9 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, @@ -13381,12 +13480,12 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapPermission" + "operationId": "DeleteSyncSyncListPermission" }, "post": { - "description": "Update an identity's access to a specific Sync Map.", + "description": "Update an identity's access to a specific Sync List.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewSyncSyncListPermission" ], "parameters": [ { @@ -13402,9 +13501,9 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, @@ -13425,19 +13524,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -13487,25 +13586,25 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapPermission", + "operationId": "UpdateSyncSyncListPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapPermissionRequest", + "title": "UpdateSyncSyncListPermissionRequest", "properties": { "Read": { "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Map." + "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 Map." + "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 Map." + "description": "Boolean flag specifying whether the identity can delete the Sync List." } }, "required": [ @@ -13528,7 +13627,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -13537,14 +13636,14 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions", "pathType": "list" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "description": "Retrieve a list of all Permissions applying to a Sync List.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewSyncSyncListPermission" ], "parameters": [ { @@ -13560,9 +13659,9 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, @@ -13606,7 +13705,7 @@ "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } }, "meta": { @@ -13642,20 +13741,20 @@ "type": "object" } }, - "title": "ListSyncSyncMapPermissionResponse" + "title": "ListSyncSyncListPermissionResponse" }, "examples": { "readEmpty": { "value": { "permissions": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, @@ -13665,22 +13764,22 @@ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "identity", "read": true, "write": true, "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -13731,10 +13830,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapPermission" + "operationId": "ListSyncSyncListPermission" } }, - "/wireless/Commands/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -13743,23 +13842,50 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], + "dependentProperties": { + "items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewWirelessCommand" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, "required": true } @@ -13769,22 +13895,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.sync.service.sync_map" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "command": "command", - "command_mode": "command_mode", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "direction": "direction", - "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "status", - "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -13834,10 +13962,50 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessCommand" + "operationId": "FetchSyncSyncMap" + }, + "delete": { + "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncMap" } }, - "/wireless/Commands": { + "/Sync/Services/{ServiceSid}/Maps": { "servers": [ { "url": "https://preview.twilio.com" @@ -13846,77 +14014,159 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], + "dependentProperties": { + "items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps", "pathType": "list" }, - "get": { + "post": { "description": "", "tags": [ - "PreviewWirelessCommand" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "Device", - "in": "query", + "name": "ServiceSid", + "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, - "examples": { - "readEmpty": { - "value": "device" - }, - "readFull": { - "value": "device" + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } - } - }, - { - "name": "Sim", - "in": "query", - "description": "", - "schema": { - "type": "string" }, - "examples": { - "readEmpty": { - "value": "sim" + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" }, - "readFull": { - "value": "sim" + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } - } - }, - { - "name": "Status", - "in": "query", - "description": "", - "schema": { - "type": "string" }, - "examples": { - "readEmpty": { - "value": "status" + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSyncSyncMap", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncMapRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + } + } }, - "readFull": { - "value": "status" + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } } } - }, + } + } + }, + "get": { + "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], + "parameters": [ { - "name": "Direction", - "in": "query", + "name": "ServiceSid", + "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, - "examples": { - "readEmpty": { - "value": "direction" - }, - "readFull": { - "value": "direction" - } - } + "required": true }, { "name": "PageSize", @@ -13953,10 +14203,10 @@ "schema": { "type": "object", "properties": { - "commands": { + "maps": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.sync.service.sync_map" } }, "meta": { @@ -13992,48 +14242,50 @@ "type": "object" } }, - "title": "ListWirelessCommandResponse" + "title": "ListSyncSyncMapResponse" }, "examples": { "readEmpty": { "value": { - "commands": [], + "maps": [], "meta": { - "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", - "key": "commands", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } }, "readFull": { "value": { - "commands": [ + "maps": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "command": "command", - "command_mode": "command_mode", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "direction": "direction", - "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "status", - "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", - "key": "commands", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } @@ -14084,144 +14336,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessCommand" - }, - "post": { - "description": "", - "tags": [ - "PreviewWirelessCommand" - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.command" - }, - "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "command": "command", - "command_mode": "command_mode", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "direction": "direction", - "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "status", - "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateWirelessCommand", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateWirelessCommandRequest", - "properties": { - "Command": { - "type": "string", - "description": "" - }, - "Device": { - "type": "string", - "description": "" - }, - "Sim": { - "type": "string", - "description": "" - }, - "CallbackMethod": { - "type": "string", - "description": "" - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "CommandMode": { - "type": "string", - "description": "" - }, - "IncludeSid": { - "type": "string", - "description": "" - } - }, - "required": [ - "Command" - ] - }, - "examples": { - "create": { - "value": { - "CallbackMethod": "callback_method", - "CallbackUrl": "http://www.example.com", - "Command": "command", - "CommandMode": "command_mode", - "Device": "device", - "Sim": "sim", - "IncludeSid": "include_sid" - } - } - } - } - } - } + "operationId": "ListSyncSyncMap" } }, - "/wireless/RatePlans": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { "servers": [ { "url": "https://preview.twilio.com" @@ -14230,40 +14348,45 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list" + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items", + "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewWirelessRatePlan" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "name": "ServiceSid", + "in": "path", + "description": "", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", + "name": "MapSid", + "in": "path", + "description": "", "schema": { - "type": "integer", - "minimum": 0 - } + "type": "string" + }, + "required": true }, { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "Key", + "in": "path", + "description": "", "schema": { "type": "string" - } + }, + "required": true } ], "responses": { @@ -14271,103 +14394,32 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "rate_plans": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "title": "ListWirelessRatePlanResponse" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { - "readEmpty": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", - "key": "rate_plans", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" - }, - "rate_plans": [] - } - }, - "readFull": { + "fetch": { "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", - "key": "rate_plans", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" - }, - "rate_plans": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "data_enabled": true, - "data_limit": 1000, - "data_metering": "pooled", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "messaging_enabled": true, - "voice_enabled": true, - "national_roaming_enabled": true, - "international_roaming": [ - "data", - "messaging", - "voice" - ], - "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ] + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -14411,47 +14463,141 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessRatePlan" + "operationId": "FetchSyncSyncMapItem" + }, + "delete": { + "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncMapItem" }, "post": { "description": "", "tags": [ - "PreviewWirelessRatePlan" + "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": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { - "create": { + "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "data_enabled": true, - "data_limit": 1000, - "data_metering": "pooled", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "messaging_enabled": true, - "voice_enabled": true, - "national_roaming_enabled": true, - "international_roaming": [ - "data", - "messaging", - "voice" - ], - "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } - } - }, - "headers": { + } + }, + "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -14487,7 +14633,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -14495,76 +14641,26 @@ "accountSid_authToken": [] } ], - "operationId": "CreateWirelessRatePlan", + "operationId": "UpdateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateWirelessRatePlanRequest", + "title": "UpdateSyncSyncMapItemRequest", "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" - }, + "Data": { "description": "" } - } + }, + "required": [ + "Data" + ] }, "examples": { - "create": { + "update": { "value": { - "UniqueName": "unique_name", - "DataEnabled": true, - "DataLimit": 1000, - "DataMetering": "pooled", - "MessagingEnabled": true, - "VoiceEnabled": true, - "FriendlyName": "friendly_name", - "NationalRoamingEnabled": true, - "InternationalRoaming": [ - "data", - "voice", - "messaging" - ], - "Status": "status" + "Data": "{}" } } } @@ -14573,7 +14669,7 @@ } } }, - "/wireless/RatePlans/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" @@ -14582,16 +14678,30 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance" + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items", + "pathType": "list" }, - "get": { + "post": { "description": "", "tags": [ - "PreviewWirelessRatePlan" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "Sid", + "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": { @@ -14601,39 +14711,36 @@ } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { - "fetch": { + "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "data_enabled": true, - "data_limit": 1000, - "data_metering": "pooled", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "messaging_enabled": true, - "voice_enabled": true, - "national_roaming_enabled": true, - "international_roaming": [ - "data", - "messaging", - "voice" - ], - "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -14669,30 +14776,150 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWirelessRatePlan" - }, - "post": { - "description": "", - "tags": [ - "PreviewWirelessRatePlan" - ], - "parameters": [ + "accountSid_authToken": [] + } + ], + "operationId": "CreateSyncSyncMapItem", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncMapItemRequest", + "properties": { + "Key": { + "type": "string", + "description": "" + }, + "Data": { + "description": "" + } + }, + "required": [ + "Key", + "Data" + ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key" + } + } + } + } + } + } + }, + "get": { + "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } + } + }, + { + "name": "From", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } + } + }, + { + "name": "Bounds", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, { - "name": "Sid", - "in": "path", - "description": "", + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" - }, - "required": true + } } ], "responses": { @@ -14700,29 +14927,89 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "title": "ListSyncSyncMapItemResponse" }, "examples": { - "update": { + "readEmpty": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "data_enabled": true, - "data_limit": 1000, - "data_metering": "pooled", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "messaging_enabled": true, - "voice_enabled": true, - "national_roaming_enabled": true, - "international_roaming": [ - "data", - "messaging", - "voice" + "items": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } ], - "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } } } } @@ -14772,66 +15059,10 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateWirelessRatePlan", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateWirelessRatePlanRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - }, - "FriendlyName": { - "type": "string", - "description": "" - } - } - }, - "examples": { - "update": { - "value": { - "UniqueName": "unique_name", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - }, - "delete": { - "description": "", - "tags": [ - "PreviewWirelessRatePlan" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteWirelessRatePlan" + "operationId": "ListSyncSyncMapItem" } }, - "/wireless/Sims/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -14840,26 +15071,41 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "usage": { - "mapping": { - "sim_sid": "sid" - }, - "resource_url": "/wireless/Sims/{sim_sid}/Usage" - } - }, + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch a specific Sync Map Permission.", "tags": [ - "PreviewWirelessSim" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "Sid", + "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" }, @@ -14871,36 +15117,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "commands_callback_method": "http_method", - "commands_callback_url": "http://www.example.com", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "sms_fallback_method": "http_method", - "sms_fallback_url": "http://www.example.com", - "sms_method": "http_method", - "sms_url": "http://www.example.com", - "voice_fallback_method": "http_method", - "voice_fallback_url": "http://www.example.com", - "voice_method": "http_method", - "voice_url": "http://www.example.com", - "links": { - "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", - "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "iccid": "iccid", - "e_id": "e_id", - "status": "status", - "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -14950,18 +15179,88 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessSim" + "operationId": "FetchSyncSyncMapPermission" }, - "post": { - "description": "", + "delete": { + "description": "Delete a specific Sync Map Permission.", "tags": [ - "PreviewWirelessSim" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncMapPermission" + }, + "post": { + "description": "Update an identity's access to a specific Sync Map.", + "tags": [ + "PreviewSyncSyncMapPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -14973,36 +15272,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "commands_callback_method": "http_method", - "commands_callback_url": "http://www.example.com", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "links": { - "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", - "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "iccid": "iccid", - "e_id": "e_id", - "status": "status", - "sms_fallback_method": "http_method", - "sms_fallback_url": "http://www.example.com", - "sms_method": "http_method", - "sms_url": "http://www.example.com", - "voice_fallback_method": "http_method", - "voice_fallback_url": "http://www.example.com", - "voice_method": "http_method", - "voice_url": "http://www.example.com", - "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -15052,130 +15334,39 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateWirelessSim", + "operationId": "UpdateSyncSyncMapPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateWirelessSimRequest", + "title": "UpdateSyncSyncMapPermissionRequest", "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": "" + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync Map." }, - "VoiceMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "GET", - "POST" - ], - "description": "" + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, - "VoiceUrl": { - "type": "string", - "format": "uri", - "description": "" + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync Map." } - } + }, + "required": [ + "Read", + "Write", + "Manage" + ] }, "examples": { "update": { "value": { - "UniqueName": "unique_name", - "CallbackMethod": "callback_method", - "CallbackUrl": "http://www.example.com", - "CommandsCallbackMethod": "http_method", - "CommandsCallbackUrl": "http://www.example.com", - "VoiceMethod": "http_method", - "VoiceUrl": "http://www.example.com", - "VoiceFallbackMethod": "http_method", - "VoiceFallbackUrl": "http://www.example.com", - "SmsMethod": "http_method", - "SmsUrl": "http://www.example.com", - "SmsFallbackMethod": "http_method", - "SmsFallbackUrl": "http://www.example.com", - "FriendlyName": "friendly_name", - "RatePlan": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "Status": "status" + "Read": "true", + "Write": "true", + "Manage": "true" } } } @@ -15184,7 +15375,7 @@ } } }, - "/wireless/Sims": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -15192,86 +15383,37 @@ ], "description": "", "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "usage": { - "mapping": { - "sim_sid": "sid" - }, - "resource_url": "/wireless/Sims/{sim_sid}/Usage" - } - }, + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions", "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync Map.", "tags": [ - "PreviewWirelessSim" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "Status", - "in": "query", - "description": "", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "status" - }, - "readFull": { - "value": "status" - } - } - }, - { - "name": "Iccid", - "in": "query", + "name": "ServiceSid", + "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, - "examples": { - "readEmpty": { - "value": "iccid" - }, - "readFull": { - "value": "iccid" - } - } + "required": true }, { - "name": "RatePlan", - "in": "query", - "description": "", + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, - "examples": { - "readEmpty": { - "value": "rate_plan" - }, - "readFull": { - "value": "rate_plan" - } - } - }, - { - "name": "EId", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "SimRegistrationCode", - "in": "query", - "description": "", - "schema": { - "type": "string" - } + "required": true }, { "name": "PageSize", @@ -15308,10 +15450,10 @@ "schema": { "type": "object", "properties": { - "sims": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } }, "meta": { @@ -15347,62 +15489,45 @@ "type": "object" } }, - "title": "ListWirelessSimResponse" + "title": "ListSyncSyncMapPermissionResponse" }, "examples": { "readEmpty": { "value": { - "sims": [], + "permissions": [], "meta": { - "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", - "key": "sims", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { - "sims": [ + "permissions": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "commands_callback_method": "http_method", - "commands_callback_url": "http://www.example.com", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "links": { - "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", - "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "iccid": "iccid", - "e_id": "e_id", - "status": "status", - "sms_fallback_method": "http_method", - "sms_fallback_url": "http://www.example.com", - "sms_method": "http_method", - "sms_url": "http://www.example.com", - "voice_fallback_method": "http_method", - "voice_fallback_url": "http://www.example.com", - "voice_method": "http_method", - "voice_url": "http://www.example.com", - "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { - "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", - "key": "sims", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -15453,132 +15578,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessSim" - } - }, - "/wireless/Sims/{SimSid}/Usage": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Sims/{Sid}", - "pathType": "instance" - }, - "get": { - "description": "", - "tags": [ - "PreviewWirelessUsage" - ], - "parameters": [ - { - "name": "SimSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "End", - "in": "query", - "description": "", - "schema": { - "type": "string" - }, - "examples": { - "fetch": { - "value": "end" - } - } - }, - { - "name": "Start", - "in": "query", - "description": "", - "schema": { - "type": "string" - }, - "examples": { - "fetch": { - "value": "start" - } - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim.usage" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "commands_costs": {}, - "commands_usage": {}, - "data_costs": {}, - "data_usage": {}, - "sim_unique_name": "sim_unique_name", - "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "period": {}, - "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage" - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWirelessUsage" + "operationId": "ListSyncSyncMapPermission" } } }, @@ -15589,19 +15589,13 @@ ], "tags": [ { - "name": "PreviewDeployedDevicesCertificate" - }, - { - "name": "PreviewDeployedDevicesDeployment" - }, - { - "name": "PreviewDeployedDevicesDevice" + "name": "PreviewHostedNumbersAuthorizationDocument" }, { - "name": "PreviewDeployedDevicesFleet" + "name": "PreviewHostedNumbersDependentHostedNumberOrder" }, { - "name": "PreviewDeployedDevicesKey" + "name": "PreviewHostedNumbersHostedNumberOrder" } ], "security": [ diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 2ffb22ad..91b991ed 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -10795,24 +10795,24 @@ paths: voice_url: null public_application_connect_enabled: false end: 0 - first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 - next_page_uri: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=1&PageToken=PAAPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa previous_page_uri: null page_size: 1 page: 0 start: 0 - uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0 readEmpty: value: applications: [] end: 0 - first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0 previous_page_uri: null page_size: 1 start: 0 next_page_uri: null page: 0 - uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?FriendlyName=friendly_name&PageSize=1&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource diff --git a/spec/yaml/twilio_iam_v1.yaml b/spec/yaml/twilio_iam_v1.yaml index 2856a1b2..7b6e6fae 100644 --- a/spec/yaml/twilio_iam_v1.yaml +++ b/spec/yaml/twilio_iam_v1.yaml @@ -143,8 +143,6 @@ paths: - sid - friendly_name - date_created - mountName: get_api_keys - className: get_api_keys pathType: list get: description: Retrieve a list of all Keys for a account. @@ -280,6 +278,9 @@ paths: security: - accountSid_authToken: [] operationId: ListGetKeys + x-twilio: + mountName: get_api_keys + className: get_api_keys post: description: Create a new Signing Key for the account making the request. tags: @@ -389,8 +390,6 @@ paths: AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa KeyType: restricted Policy: '{"allow":["/twilio/messaging/messages/read"]}' - x-twilio: - mountName: new_api_key /v1/Keys/{Sid}: servers: - url: https://iam.twilio.com diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index 1688056f..a6314246 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -378,7 +378,7 @@ components: $ref: '#/components/schemas/operator_type_enum_availability' nullable: true description: 'Operator Type availability status. Possible values: internal, - beta, public, retired.' + beta, general-availability, retired, deprecated.' configurable: type: boolean nullable: true @@ -423,7 +423,9 @@ components: - internal - beta - public + - general-availability - retired + - deprecated intelligence.v2.prebuilt_operator: type: object properties: diff --git a/spec/yaml/twilio_marketplace_v1.yaml b/spec/yaml/twilio_marketplace_v1.yaml index 7576ddfe..b8574ac6 100644 --- a/spec/yaml/twilio_marketplace_v1.yaml +++ b/spec/yaml/twilio_marketplace_v1.yaml @@ -272,6 +272,52 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: false + marketplace.v1.referral_records: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XL[0-9a-fA-F]{32}$ + nullable: false + description: The unique identifier for this resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: false + description: The account sid that owns this record. + net_revenue: + type: number + nullable: false + description: Net revenue collected as part of this record. + filename: + type: string + nullable: false + description: Name of the file attached to the record. + documentation_link: + type: string + nullable: false + description: Link to download record's invoice. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in UTC 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 UTC when the resource was created 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. info: title: Twilio - Marketplace description: This is the public Twilio REST API. @@ -1620,6 +1666,80 @@ paths: create: value: referral_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /v1/ReferralRecords: + servers: + - url: https://marketplace.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + /v1/ReferralRecords/{ReferralRecordSid}: + servers: + - url: https://marketplace.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + get: + description: Retrieve a referral record instance. + tags: + - MarketplaceReferralRecords + parameters: + - name: ReferralRecordSid + in: path + description: The SID of the Referral Record resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XL[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace.v1.referral_records' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + net_revenue: 1023.42 + filename: myfile.pdf + documentation_link: https://somelink.com + date_created: '2024-07-31T18:51:03Z' + date_updated: '2024-07-31T18:51:03Z' + url: https://marketplace.twilio.com/v1/ReferralRecords/XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchReferralRecords /v1/Listing/{Sid}: servers: - url: https://marketplace.twilio.com diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index 851b8595..184f4fb0 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -1829,7 +1829,7 @@ paths: NumberType: type: string description: The type of phone number of the Bundle's ownership - request. Can be `local`, `mobile`, `national`, or `toll free`. + request. Can be `local`, `mobile`, `national`, or `toll-free`. IsTest: type: boolean description: Indicates that Bundle is a Test Bundle and will be @@ -1905,7 +1905,7 @@ paths: - name: NumberType in: query description: The type of phone number of the Bundle's ownership request. Can - be `local`, `mobile`, `national`, or `tollfree`. + be `local`, `mobile`, `national`, or `toll-free`. schema: type: string examples: @@ -2421,7 +2421,7 @@ paths: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name - status: draft + status: twilio-approved valid_until: '2015-07-30T20:00:00Z' email: email status_callback: http://www.example.com @@ -2473,8 +2473,8 @@ paths: where the bundle needs to be cloned. MoveToDraft: type: boolean - description: This is to determine whether the cloned bundle needs - to be in draft state or not. + description: If set to true, the cloned bundle will be in the DRAFT + state, else it will be twilio-approved FriendlyName: type: string description: The string that you assigned to describe the cloned @@ -2486,7 +2486,6 @@ paths: value: FriendlyName: friendly_name TargetAccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - MoveToDraft: true /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies: servers: - url: https://numbers.twilio.com diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index 1bcb568d..b6f522c6 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -4,388 +4,262 @@ components: scheme: basic type: http schemas: - preview.deployed_devices.fleet.certificate: + preview.hosted_numbers.authorization_document: 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 + pattern: ^PX[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Fleet that the - given Certificate credential belongs to. - account_sid: + description: A 34 character string that uniquely identifies this AuthorizationDocument. + address_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Account responsible - for this Certificate credential. - device_sid: + description: A 34 character string that uniquely identifies the Address + resource that is associated with this AuthorizationDocument. + status: type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ + $ref: '#/components/schemas/authorization_document_enum_status' nullable: true - description: Specifies the unique string identifier of a Device authenticated - with this Certificate credential. - thumbprint: + 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: Contains a unique hash of the payload of this Certificate credential, - used to authenticate the Device. + 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: Specifies the date this Certificate credential was created, - given in UTC ISO 8601 format. + 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: 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. + 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 - description: Contains an absolute URL for this Deployment resource. - friendly_name: - type: string + links: + type: object + format: uri-map nullable: true - description: Contains a human readable descriptive text for this Deployment, - up to 64 characters long - fleet_sid: + 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: Specifies the unique string identifier of the Fleet that the - given Deployment belongs to. + 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: Specifies the unique string identifier of the Account responsible - for this Deployment. - sync_service_sid: + description: The unique SID identifier of the Account. + incoming_phone_number_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 + pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: Specifies the date this Deployment was created, given in UTC - ISO 8601 format. - date_updated: + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + address_sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ 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: + 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: ^TH[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ nullable: true - description: Contains a 34 character string that uniquely identifies this - Device resource. - url: + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + phone_number: type: string - format: uri + format: phone-number nullable: true - description: Contains an absolute URL for this Device resource. - unique_name: - type: string + 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: Contains a unique and addressable name of this Device, assigned - by the developer, up to 128 characters long. + description: A mapping of capabilities this hosted phone number will have + enabled on Twilio's platform. 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: + description: A human readable description of this resource, up to 64 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 + unique_name: 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: + 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: Contains an arbitrary string identifier representing a human - user associated with this Device, assigned by the developer, up to 256 - characters long. - deployment_sid: + 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 - 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. + 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: Specifies the date this Device was created, given in UTC ISO - 8601 format. + 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: Specifies the date this Device was last updated, given in UTC - ISO 8601 format. - date_authenticated: + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + verification_attempts: + type: integer + default: 0 + description: The number of attempts made to verify ownership of the phone + number that is being hosted. + email: type: string - 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}$ + 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: 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: + 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 - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' nullable: true - description: A 34 character string that uniquely identifies this AuthorizationDocument. - address_sid: + 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: ^AD[0-9a-fA-F]{32}$ + pattern: ^RI[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: + 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 - $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: + description: A numerical extension to be used when making the ownership + verification call. + call_delay: + type: integer + default: 0 + description: A value between 0-30 specifying the number of seconds to delay + initiating the ownership verification call. + verification_code: type: string nullable: true - description: Email that this AuthorizationDocument will be sent to for signing. - x-twilio: - pii: - handling: standard - deleteSla: 30 - cc_emails: + description: The digits passed during the ownership verification call. + verification_call_sids: 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: + 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: - - opened - - signing - - signed - - canceled + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed - failed - preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + - 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: @@ -394,23 +268,22 @@ components: maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this Authorization - Document + 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: The unique SID identifier of the Account. + 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 - resource created by this HostedNumberOrder. + 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 @@ -425,13 +298,15 @@ components: 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. + 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: An E164 formatted phone number hosted by this HostedNumberOrder. + 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 @@ -445,12 +320,13 @@ components: fax: type: boolean nullable: true - description: A mapping of capabilities this hosted phone number will have - enabled on Twilio's platform. + 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 human readable description of this resource, up to 64 characters. + description: A 64 character string that is a human-readable text that describes + this resource. x-twilio: pii: handling: standard @@ -467,12 +343,13 @@ components: deleteSla: 30 status: type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + $ref: '#/components/schemas/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.' + 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 @@ -508,205 +385,20 @@ components: items: type: string nullable: true - description: Email recipients who will be informed when an Authorization - Document has been sent and signed + 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/dependent_hosted_number_order_enum_verification_type' - nullable: true - description: The method used for verifying ownership of the number to be - hosted. One of phone-call (default) or phone-bill. - verification_document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Identity - Document resource that represents the document for verifying ownership - of the number to be hosted. - extension: - type: string - nullable: true - description: A numerical extension to be used when making the ownership - verification call. - call_delay: - type: integer - default: 0 - description: A value between 0-30 specifying the number of seconds to delay - initiating the ownership verification call. - verification_code: - type: string - nullable: true - description: The digits passed during the ownership verification call. - verification_call_sids: - type: array - items: - type: string - nullable: true - description: A list of 34 character strings that are unique identifiers - for the calls placed as part of ownership verification. - dependent_hosted_number_order_enum_status: - type: string - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - dependent_hosted_number_order_enum_verification_type: - type: string - enum: - - phone-call - - phone-bill - preview.hosted_numbers.hosted_number_order: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this HostedNumberOrder. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the account. - incoming_phone_number_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) - resource that represents the phone number being hosted. - address_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Address - resource that represents the address of the owner of this phone number. - signing_document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the [Authorization - Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) - the user needs to sign. - phone_number: - type: string - format: phone-number - nullable: true - description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) - format, e.g., +16175551212 - capabilities: - type: object - format: phone-number-capabilities - properties: - mms: - type: boolean - sms: - type: boolean - voice: - type: boolean - fax: - type: boolean - nullable: true - description: Set of booleans describing the capabilities hosted on Twilio's - platform. SMS is currently only supported. - friendly_name: - type: string - nullable: true - description: A 64 character string that is a human-readable text that describes - this resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 - unique_name: - type: string - nullable: true - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in - addition to SID. - x-twilio: - pii: - handling: standard - deleteSla: 30 - status: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - nullable: true - description: 'Status of this resource. It can hold one of the values: 1. - Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, - 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders - Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) - section for more information on each of these statuses.' - failure_reason: - type: string - nullable: true - description: A message that explains why a hosted_number_order went to status - "action-required" - date_created: - type: string - format: date-time - nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. - date_updated: - type: string - format: date-time - nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - verification_attempts: - type: integer - default: 0 - description: The number of attempts made to verify ownership of the phone - number that is being hosted. - email: - type: string - nullable: true - description: Email of the owner of this phone number that is being hosted. - x-twilio: - pii: - handling: standard - deleteSla: 30 - cc_emails: - type: array - items: - type: string - nullable: true - description: A list of emails that LOA document for this HostedNumberOrder - will be carbon copied to. - x-twilio: - pii: - handling: standard - deleteSla: 30 - url: - type: string - format: uri - nullable: true - description: The URL of this HostedNumberOrder. - verification_type: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + $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`. @@ -932,17 +624,14 @@ components: format: uri nullable: true description: The absolute URL of the resource. - preview.sync.service.document: + preview.wireless.command: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - nullable: true - unique_name: - type: string + pattern: ^DC[0-9a-fA-F]{32}$ nullable: true account_sid: type: string @@ -950,24 +639,29 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - service_sid: + device_sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - url: + sim_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - links: - type: object - format: uri-map + command: + type: string nullable: true - revision: + command_mode: type: string nullable: true - data: + status: + type: string + nullable: true + direction: + type: string nullable: true date_created: type: string @@ -977,76 +671,53 @@ components: type: string format: date-time nullable: true - created_by: + url: type: string + format: uri nullable: true - preview.sync.service.document.document_permission: + preview.wireless.rate_plan: type: object properties: - account_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + unique_name: 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: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync Document to which the - Permission applies. - identity: + friendly_name: type: string nullable: true - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: + data_enabled: type: boolean nullable: true - description: Boolean flag specifying whether the identity can read the Sync - Document. - write: - type: boolean + data_metering: + type: string nullable: true - description: Boolean flag specifying whether the identity can update the - Sync Document. - manage: + data_limit: + type: integer + default: 0 + messaging_enabled: 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}$ + voice_enabled: + type: boolean nullable: true - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + national_roaming_enabled: + type: boolean nullable: true - friendly_name: - type: string + international_roaming: + type: array + items: + type: string nullable: true date_created: type: string @@ -1060,28 +731,14 @@ components: 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: + preview.wireless.sim: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true unique_name: type: string @@ -1092,66 +749,74 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - service_sid: + rate_plan_sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - url: + friendly_name: type: string - format: uri nullable: true - links: - type: object - format: uri-map + iccid: + type: string nullable: true - revision: + e_id: type: string nullable: true - date_created: + status: type: string - format: date-time nullable: true - date_updated: + commands_callback_url: type: string - format: date-time + format: uri nullable: true - created_by: + commands_callback_method: type: string nullable: true - preview.sync.service.sync_list.sync_list_item: - type: object - properties: - index: - type: integer - default: 0 - account_sid: + sms_fallback_method: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: http-method + enum: + - GET + - POST nullable: true - service_sid: + sms_fallback_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + format: uri nullable: true - list_sid: + sms_method: type: string - minLength: 34 - maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ + format: http-method + enum: + - GET + - POST nullable: true - url: + sms_url: type: string format: uri nullable: true - revision: + voice_fallback_method: + type: string + format: http-method + enum: + - GET + - POST + nullable: true + voice_fallback_url: type: string + format: uri nullable: true - data: + voice_method: + type: string + format: http-method + enum: + - GET + - POST + nullable: true + voice_url: + type: string + format: uri nullable: true date_created: type: string @@ -1161,334 +826,362 @@ components: type: string format: date-time nullable: true - created_by: + url: type: string + format: uri 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: + links: + type: object + format: uri-map + nullable: true + preview.wireless.sim.usage: type: object properties: - account_sid: + sim_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + sim_unique_name: 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: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync List to which the Permission - applies. - identity: - type: string + period: nullable: true - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: - type: boolean + commands_usage: nullable: true - description: Boolean flag specifying whether the identity can read the Sync - List and its Items. - write: - type: boolean + commands_costs: nullable: true - description: Boolean flag specifying whether the identity can create, update - and delete Items of the Sync List. - manage: - type: boolean + data_usage: + nullable: true + data_costs: 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: + preview.deployed_devices.fleet.certificate: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ + pattern: ^CY[0-9a-fA-F]{32}$ nullable: true - unique_name: + 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 - service_sid: + description: Specifies the unique string identifier of the Account responsible + for this Certificate credential. + device_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 + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - revision: + 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 - created_by: - type: string - nullable: true - preview.sync.service.sync_map.sync_map_item: + description: Specifies the date this Certificate credential was last updated, + given in UTC ISO 8601 format. + preview.deployed_devices.fleet.deployment: type: object properties: - key: - type: string - nullable: true - account_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^DL[0-9a-fA-F]{32}$ nullable: true - service_sid: + description: Contains a 34 character string that uniquely identifies this + Deployment resource. + url: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + format: uri nullable: true - map_sid: + description: Contains an absolute URL for this Deployment resource. + friendly_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - url: + description: Contains a human readable descriptive text for this Deployment, + up to 64 characters long + fleet_sid: type: string - format: uri nullable: true - revision: + 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 - data: + 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 - 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: + description: Specifies the date this Deployment was last updated, given + in UTC ISO 8601 format. + preview.deployed_devices.fleet.device: type: object properties: - account_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + description: Contains a 34 character string that uniquely identifies this + Device resource. + url: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + format: uri nullable: true - description: The unique SID identifier of the Sync Service Instance. - map_sid: + description: Contains an absolute URL for this Device resource. + unique_name: 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: + 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: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: - type: boolean + description: Contains a human readable descriptive text for this Device, + up to 256 characters long + fleet_sid: + type: string nullable: true - description: Boolean flag specifying whether the identity can read the Sync - Map and its Items. - write: + description: Specifies the unique string identifier of the Fleet that the + given Device belongs to. + enabled: type: boolean nullable: true - description: Boolean flag specifying whether the identity can create, update - and delete Items of the Sync Map. - manage: - type: boolean + 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: Boolean flag specifying whether the identity can delete the - Sync Map. - url: + description: Specifies the unique string identifier of the Account responsible + for this Device. + identity: type: string - format: uri nullable: true - description: Contains an absolute URL for this Sync Map Permission. - preview.wireless.command: - type: object - properties: - sid: + 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: ^DC[0-9a-fA-F]{32}$ + pattern: ^DL[0-9a-fA-F]{32}$ nullable: true - account_sid: + description: Specifies the unique string identifier of the Deployment group + that this Device is associated with. + date_created: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: date-time nullable: true - device_sid: + description: Specifies the date this Device was created, given in UTC ISO + 8601 format. + date_updated: type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + format: date-time nullable: true - sim_sid: + 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: ^DE[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - command: + description: Contains a 34 character string that uniquely identifies this + Fleet resource. + url: type: string + format: uri nullable: true - command_mode: + description: Contains an absolute URL for this Fleet resource. + unique_name: type: string nullable: true - status: + description: Contains a unique and addressable name of this Fleet, e.g. + 'default', up to 128 characters long. + friendly_name: type: string nullable: true - direction: + 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 - url: - type: string - format: uri + description: Specifies the date this Fleet was last updated, given in UTC + ISO 8601 format. + links: + type: object + format: uri-map nullable: true - preview.wireless.rate_plan: + 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: ^WP[0-9a-fA-F]{32}$ + pattern: ^KY[0-9a-fA-F]{32}$ nullable: true - unique_name: + 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 - friendly_name: + 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 - data_enabled: - type: boolean - nullable: true - data_metering: + description: Specifies the unique string identifier of a Device authenticated + with this Key credential. + secret: type: string nullable: true - data_limit: - type: integer - default: 0 - messaging_enabled: - type: boolean - nullable: true - voice_enabled: - type: boolean - nullable: true - national_roaming_enabled: - type: boolean - nullable: true - international_roaming: - type: array - items: - type: string - nullable: true + 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 - url: - type: string - format: uri - nullable: true - preview.wireless.sim: + description: Specifies the date this Key credential was last updated, given + in UTC ISO 8601 format. + preview.sync.service.document: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + pattern: ^ET[0-9a-fA-F]{32}$ nullable: true unique_name: type: string @@ -1499,74 +1192,103 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - rate_plan_sid: + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - friendly_name: + url: type: string + format: uri nullable: true - iccid: - type: string + links: + type: object + format: uri-map nullable: true - e_id: + revision: type: string nullable: true - status: - type: string + data: nullable: true - commands_callback_url: + date_created: type: string - format: uri + format: date-time nullable: true - commands_callback_method: + date_updated: type: string + format: date-time nullable: true - sms_fallback_method: + created_by: type: string - format: http-method - enum: - - GET - - POST nullable: true - sms_fallback_url: + preview.sync.service.document.document_permission: + type: object + properties: + account_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - sms_method: + description: The unique SID identifier of the Twilio Account. + service_sid: type: string - format: http-method - enum: - - GET - - POST + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - sms_url: + description: The unique SID identifier of the Sync Service Instance. + document_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - voice_fallback_method: + description: The unique SID identifier of the Sync Document to which the + Permission applies. + identity: type: string - format: http-method - enum: - - GET - - POST nullable: true - voice_fallback_url: + 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 - voice_method: + description: Contains an absolute URL for this Sync Document Permission. + preview.sync.service: + type: object + properties: + sid: type: string - format: http-method - enum: - - GET - - POST + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - voice_url: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + friendly_name: type: string - format: uri nullable: true date_created: type: string @@ -1580,20 +1302,30 @@ components: 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.wireless.sim.usage: + preview.sync.service.sync_list: type: object properties: - sim_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - sim_unique_name: + unique_name: type: string nullable: true account_sid: @@ -1602,83 +1334,350 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - period: + service_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - commands_usage: + url: + type: string + format: uri nullable: true - commands_costs: + links: + type: object + format: uri-map nullable: true - data_usage: + revision: + type: string nullable: true - data_costs: + date_created: + type: string + format: date-time + nullable: true + date_updated: + type: string + format: date-time + nullable: true + created_by: + type: string + nullable: true + preview.sync.service.sync_list.sync_list_item: + type: object + properties: + index: + type: integer + default: 0 + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + service_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + nullable: true + list_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true -info: - title: Twilio - Preview - description: This is the public Twilio REST API. - termsOfService: https://www.twilio.com/legal/tos - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.0.0 -openapi: 3.0.1 -paths: - /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - get: - description: Fetch information about a specific Certificate credential in the - Fleet. - tags: - - PreviewDeployedDevicesCertificate - parameters: - - name: FleetSid - in: path - description: '' - schema: + revision: type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - schema: + 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: ^CY[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - examples: - fetch: - value: - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: + 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. +info: + title: Twilio - Preview + description: This is the public Twilio REST API. + termsOfService: https://www.twilio.com/legal/tos + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 1.0.0 +openapi: 3.0.1 +paths: + /HostedNumbers/AuthorizationDocuments/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + pathType: instance + get: + description: Fetch a specific AuthorizationDocument. + tags: + - PreviewHostedNumbersAuthorizationDocument + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + fetch: + value: + address_sid: AD11111111111111111111111111111111 + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -1706,75 +1705,262 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesCertificate - delete: - description: Unregister a specific Certificate credential from the Fleet, effectively - disallowing any inbound client connections that are presenting it. + operationId: FetchHostedNumbersAuthorizationDocument + post: + description: Updates a specific AuthorizationDocument. tags: - - PreviewDeployedDevicesCertificate + - PreviewHostedNumbersAuthorizationDocument 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. + description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string minLength: 34 maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + update: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK security: - accountSid_authToken: [] - operationId: DeleteDeployedDevicesCertificate - post: - description: Update the given properties of a specific Certificate credential - in the Fleet, giving it a friendly name or assigning to a Device. + operationId: UpdateHostedNumbersAuthorizationDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateHostedNumbersAuthorizationDocumentRequest + properties: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + Status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + description: 'Status of an instance resource. It can hold one of + the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, + 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. + examples: + update: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + Status: signing + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + pathType: list + get: + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. tags: - - PreviewDeployedDevicesCertificate + - PreviewHostedNumbersAuthorizationDocument parameters: - - name: FleetSid - in: path - description: '' + - name: Email + in: query + description: Email that this AuthorizationDocument will be sent to for signing. schema: type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: test+hosted@twilio.com + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + examples: + readEmpty: + value: signed + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - 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' + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + title: ListHostedNumbersAuthorizationDocumentResponse examples: - update: + readEmpty: value: - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + items: + - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -1803,68 +1989,33 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesCertificate - 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. - examples: - update: - value: - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - /DeployedDevices/Fleets/{FleetSid}/Certificates: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list + operationId: ListHostedNumbersAuthorizationDocument post: - description: Enroll a new Certificate credential to the Fleet, optionally giving - it a friendly name and assigning to a Device. + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. tags: - - PreviewDeployedDevicesCertificate - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true + - PreviewHostedNumbersAuthorizationDocument responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' examples: create: value: - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -1893,58 +2044,148 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesCertificate + operationId: CreateHostedNumbersAuthorizationDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesCertificateRequest + title: CreateHostedNumbersAuthorizationDocumentRequest 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: + 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: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. + 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: - - CertificateData + - HostedNumberOrderSids + - AddressSid + - Email + - ContactTitle + - ContactPhoneNumber examples: create: value: - CertificateData: 12345678abcdef - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /AuthorizationDocuments/{Sid} + pathType: list get: - description: Retrieve a list of all Certificate credentials belonging to the - Fleet. + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. tags: - - PreviewDeployedDevicesCertificate + - PreviewHostedNumbersDependentHostedNumberOrder parameters: - - name: FleetSid + - name: SigningDocumentSid in: path - description: '' + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. schema: type: string - required: true - - name: DeviceSid + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid in: query - description: Filters the resulting list of Certificates by a unique string - identifier of an authenticated Device. + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1971,10 +2212,10 @@ paths: schema: type: object properties: - certificates: + items: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' meta: properties: first_page_url: @@ -1998,39 +2239,58 @@ paths: format: uri type: string type: object - title: ListDeployedDevicesCertificateResponse + title: ListHostedNumbersDependentHostedNumberOrderResponse examples: readEmpty: value: - certificates: [] meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 - key: certificates + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + items: [] readFull: value: - certificates: - - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 - key: certificates + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + failure_reason: '' + unique_name: foobar + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2059,150 +2319,66 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesCertificate - /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: + operationId: ListHostedNumbersDependentHostedNumberOrder + /HostedNumbers/HostedNumberOrders/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Fleets/{Sid} pathType: instance get: - description: Fetch information about a specific Deployment in the Fleet. + description: Fetch a specific HostedNumberOrder. tags: - - PreviewDeployedDevicesDeployment + - PreviewHostedNumbersHostedNumberOrder 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. + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' examples: fetch: value: - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesDeployment - 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 - 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' - examples: - update: - value: - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '5105' + failure_reason: '' friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2231,68 +2407,80 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDeployment - 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. - examples: - update: - value: - FriendlyName: friendly_name - SyncServiceSid: sync_service_sid - /DeployedDevices/Fleets/{FleetSid}/Deployments: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list + operationId: FetchHostedNumbersHostedNumberOrder + delete: + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). + tags: + - PreviewHostedNumbersHostedNumberOrder + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteHostedNumbersHostedNumberOrder post: - description: Create a new Deployment in the Fleet, optionally giving it a friendly - name and linking to a specific Twilio Sync service instance. + description: Updates a specific HostedNumberOrder. tags: - - PreviewDeployedDevicesDeployment + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: FleetSid + - name: Sid in: path - description: '' + 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' examples: - create: + update: value: - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: new friendly name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: pending-loa + unique_name: new unique name + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 1 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2318,45 +2506,150 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: Created + description: OK security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesDeployment + operationId: UpdateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesDeploymentRequest + title: UpdateHostedNumbersHostedNumberOrderRequest properties: FriendlyName: type: string - description: Provides a human readable descriptive text for this - Deployment, up to 256 characters long. - SyncServiceSid: + 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: ^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. + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + Extension: + type: string + description: Digits to dial after connecting the verification call. + CallDelay: + type: integer + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. examples: - create: + update: value: - FriendlyName: friendly_name - SyncServiceSid: sync_service_sid + FriendlyName: new friendly name + UniqueName: new unique name + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + Status: pending-loa + Extension: '1234' + CallDelay: 15 + /HostedNumbers/HostedNumberOrders: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: list get: - description: Retrieve a list of all Deployments belonging to the Fleet. + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. tags: - - PreviewDeployedDevicesDeployment + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: FleetSid - in: path - description: '' + - 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 - required: true + $ref: '#/components/schemas/hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2383,10 +2676,10 @@ paths: schema: type: object properties: - deployments: + items: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' meta: properties: first_page_url: @@ -2410,38 +2703,59 @@ paths: format: uri type: string type: object - title: ListDeployedDevicesDeploymentResponse + title: ListHostedNumbersHostedNumberOrderResponse examples: readEmpty: value: - deployments: [] meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 - key: deployments + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + items: [] readFull: value: - deployments: - - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 - key: deployments + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2470,148 +2784,99 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesDeployment - /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - get: - description: Fetch information about a specific Device in the Fleet. + operationId: ListHostedNumbersHostedNumberOrder + post: + description: Host a phone number's capability on Twilio's platform. 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 + - PreviewHostedNumbersHostedNumberOrder responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' examples: - fetch: + create: value: - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesDevice - 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 - 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' - examples: - update: + address_sid: AD11111111111111111111111111111111 + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithoutOptionalLoaFields: value: - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithPhoneBillVerification: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_type: phone-bill headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2637,82 +2902,196 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: OK + description: Created security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDevice + operationId: CreateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateDeployedDevicesDeviceRequest + 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: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - Identity: + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: type: string - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - DeploymentSid: + 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: ^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: '' + pattern: ^AP[0-9a-fA-F]{32}$ + description: Optional. The 34 character sid of the application Twilio + should use to handle SMS messages sent to this number. If a `SmsApplicationSid` + is present, Twilio will ignore all of the SMS urls above and use + those set on the application. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + Email: + type: string + description: Optional. Email of the owner of this phone number that + is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + required: + - PhoneNumber + - SmsCapability examples: - update: + create: value: - FriendlyName: friendly_name - Identity: identity - /DeployedDevices/Fleets/{FleetSid}/Devices: + AddressSid: AD11111111111111111111111111111111 + PhoneNumber: '+14153608311' + SmsCapability: true + Email: test@twilio.com + createWithoutOptionalLoaFields: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + createWithPhoneBillVerification: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + VerificationType: phone-bill + VerificationDocumentSid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /marketplace/AvailableAddOns/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list - 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. + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + pathType: instance + get: + description: Fetch an instance of an Add-on currently available to be installed. tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceAvailableAddOn parameters: - - name: FleetSid + - name: Sid in: path - description: '' + 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + $ref: '#/components/schemas/preview.marketplace.available_add_on' examples: - create: + fetch: value: - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2736,69 +3115,29 @@ paths: Access-Control-Expose-Headers: description: Headers exposed to the client schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesDevice - 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: '' - examples: - create: - value: - FriendlyName: friendly_name - UniqueName: unique_name - Identity: identity + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceAvailableAddOn + /marketplace/AvailableAddOns: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + pathType: list get: - description: Retrieve a list of all Devices belonging to the Fleet. + description: Retrieve a list of Add-ons currently available to be installed. tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceAvailableAddOn 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 @@ -2825,10 +3164,10 @@ paths: schema: type: object properties: - devices: + available_add_ons: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + $ref: '#/components/schemas/preview.marketplace.available_add_on' meta: properties: first_page_url: @@ -2852,42 +3191,44 @@ paths: format: uri type: string type: object - title: ListDeployedDevicesDeviceResponse + title: ListMarketplaceAvailableAddOnResponse examples: - readEmpty: + readFull: value: - devices: [] + available_add_ons: + - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - key: devices - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - readFull: + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons + readEmpty: value: - devices: - - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_ons: [] meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - key: devices - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2916,65 +3257,55 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesDevice - /DeployedDevices/Fleets/{Sid}: + operationId: ListMarketplaceAvailableAddOn + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - 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 + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension pathType: instance get: - description: Fetch information about a specific Fleet in your account. + description: Fetch an instance of an Extension for the Available Add-on. tags: - - PreviewDeployedDevicesFleet + - 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: Provides a 34 character string that uniquely identifies the requested - Fleet resource. + 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.deployed_devices.fleet' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' examples: fetch: value: - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3003,60 +3334,114 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesFleet - delete: - description: 'Delete a specific Fleet from your account, also destroys all nested - resources: Devices, Deployments, Certificates, Keys.' + operationId: FetchMarketplaceAvailableAddOnExtension + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension + pathType: list + get: + description: Retrieve a list of Extensions for the Available Add-on. tags: - - PreviewDeployedDevicesFleet + - PreviewMarketplaceAvailableAddOnExtension parameters: - - name: Sid + - name: AvailableAddOnSid in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. + 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 - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesFleet - 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. + - 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 - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + type: object + properties: + extensions: + type: array + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + title: ListMarketplaceAvailableAddOnExtensionResponse examples: - update: + readFull: + value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: value: - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + extensions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3085,81 +3470,49 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesFleet - 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. - examples: - update: - value: - FriendlyName: friendly_name - DefaultDeploymentSid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /DeployedDevices/Fleets: + operationId: ListMarketplaceAvailableAddOnExtension + /marketplace/InstalledAddOns: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] 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: + extensions: mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates - keys: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage pathType: list post: - description: Create a new Fleet for scoping of deployed devices within your - account. + description: Install an Add-on for the Account specified. tags: - - PreviewDeployedDevicesFleet + - PreviewMarketplaceInstalledAddOn responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' examples: create: value: - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_1 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3188,26 +3541,44 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesFleet + operationId: CreateMarketplaceInstalledAddOn requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesFleetRequest + title: CreateMarketplaceInstalledAddOnRequest properties: - FriendlyName: + AvailableAddOnSid: type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. + minLength: 34 + maxLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + description: The SID of the AvaliableAddOn to install. + AcceptTermsOfService: + type: boolean + description: Whether the Terms of Service were accepted. + Configuration: + description: The JSON object that represents the configuration of + the new Add-on being installed. + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + required: + - AvailableAddOnSid + - AcceptTermsOfService examples: create: value: - FriendlyName: friendly_name + AvailableAddOnSid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AcceptTermsOfService: true + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_1 get: - description: Retrieve a list of all Fleets belonging to your account. + description: Retrieve a list of Add-ons currently installed on this Account. tags: - - PreviewDeployedDevicesFleet + - PreviewMarketplaceInstalledAddOn parameters: - name: PageSize in: query @@ -3235,10 +3606,10 @@ paths: schema: type: object properties: - fleets: + installed_add_ons: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' meta: properties: first_page_url: @@ -3262,119 +3633,43 @@ paths: format: uri type: string type: object - title: ListDeployedDevicesFleetResponse + title: ListMarketplaceInstalledAddOnResponse examples: - readEmpty: - value: - fleets: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - key: fleets - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 readFull: value: - fleets: - - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name + installed_add_ons: + - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - key: fleets - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesFleet - /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - 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' - examples: - fetch: + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons + readEmpty: value: - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_ons: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3403,165 +3698,79 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesKey + operationId: ListMarketplaceInstalledAddOn + /marketplace/InstalledAddOns/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + extensions: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + pathType: instance delete: - description: Delete a specific Key credential from the Fleet, effectively disallowing - any inbound client connections that are presenting it. + description: Remove an Add-on installation from your account tags: - - PreviewDeployedDevicesKey + - PreviewMarketplaceInstalledAddOn 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. + description: The SID of the InstalledAddOn resource to delete. schema: type: string minLength: 34 maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteDeployedDevicesKey - post: - description: Update the given properties of a specific Key credential in the - Fleet, giving it a friendly name or assigning to a Device. + operationId: DeleteMarketplaceInstalledAddOn + get: + description: Fetch an instance of an Add-on currently installed on this Account. tags: - - PreviewDeployedDevicesKey + - PreviewMarketplaceInstalledAddOn 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. + description: The SID of the InstalledAddOn resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - examples: - update: - value: - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesKey - 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. - examples: - update: - value: - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - /DeployedDevices/Fleets/{FleetSid}/Keys: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list - 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' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' examples: - create: + fetch: value: - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3584,142 +3793,49 @@ paths: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesKey - 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. - examples: - create: - value: - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - 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 + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceInstalledAddOn + post: + description: Update an Add-on installation for the Account specified. + tags: + - PreviewMarketplaceInstalledAddOn + parameters: + - name: Sid + in: path + description: The SID of the InstalledAddOn resource to update. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true responses: '200': content: application/json: schema: - type: object - properties: - keys: - type: array - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - title: ListDeployedDevicesKeyResponse + $ref: '#/components/schemas/preview.marketplace.installed_add_on' examples: - readEmpty: - value: - keys: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - key: keys - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - readFull: + update: value: - keys: - - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - key: keys - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_2 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3748,54 +3864,76 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesKey - /HostedNumbers/AuthorizationDocuments/{Sid}: + operationId: UpdateMarketplaceInstalledAddOn + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateMarketplaceInstalledAddOnRequest + properties: + Configuration: + description: Valid JSON object that conform to the configuration + schema exposed by the associated AvailableAddOn resource. This + is only required by Add-ons that need to be configured + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + examples: + update: + value: + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_2 + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - dependent_hosted_number_orders: - mapping: - signing_document_sid: sid - resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension pathType: instance get: - description: Fetch a specific AuthorizationDocument. + description: Fetch an instance of an Extension for the Installed Add-on. tags: - - PreviewHostedNumbersAuthorizationDocument + - 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: A 34 character string that uniquely identifies this AuthorizationDocument. + description: The SID of the InstalledAddOn Extension resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' examples: fetch: value: - address_sid: AD11111111111111111111111111111111 - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3824,42 +3962,47 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchHostedNumbersAuthorizationDocument + operationId: FetchMarketplaceInstalledAddOnExtension post: - description: Updates a specific AuthorizationDocument. + description: Update an Extension for an Add-on installation. tags: - - PreviewHostedNumbersAuthorizationDocument + - 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: A 34 character string that uniquely identifies this AuthorizationDocument. + description: The SID of the InstalledAddOn Extension resource to update. schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' examples: update: value: - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: false + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -3884,113 +4027,51 @@ paths: description: Headers exposed to the client schema: type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateHostedNumbersAuthorizationDocument - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - Status: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - description: 'Status of an instance resource. It can hold one of - the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, - 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateMarketplaceInstalledAddOnExtension + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateMarketplaceInstalledAddOnExtensionRequest + properties: + Enabled: + type: boolean + description: Whether the Extension should be invoked. + required: + - Enabled examples: update: value: - AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - Email: test+hosted@twilio.com - CcEmails: - - test1@twilio.com - - test2@twilio.com - HostedNumberOrderSids: - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 - Status: signing - ContactTitle: Mr. - ContactPhoneNumber: '+14155555555' - /HostedNumbers/AuthorizationDocuments: + Enabled: false + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - dependent_hosted_number_orders: - mapping: - signing_document_sid: sid - resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension pathType: list get: - description: Retrieve a list of AuthorizationDocuments belonging to the account - initiating the request. + description: Retrieve a list of Extensions for the Installed Add-on. tags: - - PreviewHostedNumbersAuthorizationDocument + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: Email - in: query - description: Email that this AuthorizationDocument will be sent to for signing. - schema: - type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - examples: - readEmpty: - value: test+hosted@twilio.com - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' + - name: InstalledAddOnSid + in: path + description: The SID of the InstalledAddOn resource with the extensions to + read. schema: type: string - $ref: '#/components/schemas/authorization_document_enum_status' - examples: - readEmpty: - value: signed + 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 @@ -4017,10 +4098,10 @@ paths: schema: type: object properties: - items: + extensions: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' meta: properties: first_page_url: @@ -4044,42 +4125,37 @@ paths: format: uri type: string type: object - title: ListHostedNumbersAuthorizationDocumentResponse + title: ListMarketplaceInstalledAddOnExtensionResponse examples: - readEmpty: + readFull: value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 - key: items - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 - items: [] - readFull: + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: value: + extensions: [] meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 - key: items - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 - items: - - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -4108,203 +4184,129 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersAuthorizationDocument - post: - description: Create an AuthorizationDocument for authorizing the hosting of - phone number capabilities on Twilio's platform. + operationId: ListMarketplaceInstalledAddOnExtension + /wireless/Commands/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + get: + description: '' tags: - - PreviewHostedNumbersAuthorizationDocument + - PreviewWirelessCommand + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ + required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.wireless.command' examples: - create: + fetch: value: - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: Created - security: - - accountSid_authToken: [] - operationId: CreateHostedNumbersAuthorizationDocument - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - required: - - HostedNumberOrderSids - - AddressSid - - Email - - ContactTitle - - ContactPhoneNumber - examples: - create: - value: - AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - Email: test+hosted@twilio.com - CcEmails: - - test1@twilio.com - - test2@twilio.com - HostedNumberOrderSids: - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 - ContactTitle: Mr. - ContactPhoneNumber: '+14155555555' - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWirelessCommand + /wireless/Commands: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /AuthorizationDocuments/{Sid} pathType: list get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. + description: '' tags: - - PreviewHostedNumbersDependentHostedNumberOrder + - PreviewWirelessCommand parameters: - - name: SigningDocumentSid - in: path - description: A 34 character string that uniquely identifies the LOA document - associated with this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - required: true - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' - examples: - readEmpty: - value: completed - - name: PhoneNumber + - name: Device in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. + description: '' schema: type: string - format: phone-number examples: readEmpty: - value: '+19193608000' - - name: IncomingPhoneNumberSid + value: device + readFull: + value: device + - name: Sim in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ examples: readEmpty: - value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - name: FriendlyName + value: sim + readFull: + value: sim + - name: Status in: query - description: A human readable description of this resource, up to 64 characters. + description: '' schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 examples: readEmpty: - value: example - - name: UniqueName + value: status + readFull: + value: status + - name: Direction 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. + description: '' schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 examples: readEmpty: - value: something123 + value: direction + readFull: + value: direction - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4331,10 +4333,10 @@ paths: schema: type: object properties: - items: + commands: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' + $ref: '#/components/schemas/preview.wireless.command' meta: properties: first_page_url: @@ -4358,146 +4360,41 @@ paths: format: uri type: string type: object - title: ListHostedNumbersDependentHostedNumberOrderResponse + title: ListWirelessCommandResponse examples: readEmpty: value: + commands: [] meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 - items: [] - readFull: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 - key: items + first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + key: commands next_page_url: null page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 - items: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: '1234' - friendly_name: friendly_name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: received - failure_reason: '' - unique_name: foobar - verification_attempts: 0 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersDependentHostedNumberOrder - /HostedNumbers/HostedNumberOrders/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: instance - get: - description: Fetch a specific HostedNumberOrder. - tags: - - PreviewHostedNumbersHostedNumberOrder - parameters: - - name: Sid - in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: '5105' - failure_reason: '' - friendly_name: friendly_name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: received - unique_name: foobar - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + readFull: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -4526,80 +4423,31 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchHostedNumbersHostedNumberOrder - delete: - description: Cancel the HostedNumberOrder (only available when the status is - in `received`). - tags: - - PreviewHostedNumbersHostedNumberOrder - parameters: - - name: Sid - in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteHostedNumbersHostedNumberOrder + operationId: ListWirelessCommand post: - description: Updates a specific HostedNumberOrder. + description: '' 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 + - PreviewWirelessCommand responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.wireless.command' examples: - update: + create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - extension: '1234' - failure_reason: '' - friendly_name: new friendly name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: pending-loa - unique_name: new unique name - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 1 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -4625,80 +4473,52 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: OK + description: Created security: - accountSid_authToken: [] - operationId: UpdateHostedNumbersHostedNumberOrder + operationId: CreateWirelessCommand requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateHostedNumbersHostedNumberOrderRequest + title: CreateWirelessCommandRequest properties: - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: + Command: 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: + description: '' + Device: 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: + description: '' + Sim: 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: + description: '' + CallbackMethod: 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: + description: '' + CallbackUrl: 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: + format: uri + description: '' + CommandMode: 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: + description: '' + IncludeSid: 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. + description: '' + required: + - Command examples: - update: + create: value: - FriendlyName: new friendly name - UniqueName: new unique name - Email: test+hosted@twilio.com - CcEmails: - - test1@twilio.com - - test2@twilio.com - Status: pending-loa - Extension: '1234' - CallDelay: 15 - /HostedNumbers/HostedNumberOrders: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: command_mode + Device: device + Sim: sim + IncludeSid: include_sid + /wireless/RatePlans: servers: - url: https://preview.twilio.com description: '' @@ -4706,69 +4526,10 @@ paths: defaultOutputProperties: [] pathType: list get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. + description: '' tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewWirelessRatePlan parameters: - - name: Status - in: query - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. - schema: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - examples: - readEmpty: - value: completed - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - examples: - readEmpty: - value: '+19193608000' - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - examples: - readEmpty: - value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - examples: - readEmpty: - value: example - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - examples: - readEmpty: - value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4795,10 +4556,10 @@ paths: schema: type: object properties: - items: + rate_plans: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.wireless.rate_plan' meta: properties: first_page_url: @@ -4822,59 +4583,47 @@ paths: format: uri type: string type: object - title: ListHostedNumbersHostedNumberOrderResponse + title: ListWirelessRatePlanResponse examples: readEmpty: value: meta: - first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 - key: items + first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + key: rate_plans next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 - items: [] + url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + rate_plans: [] readFull: value: meta: - first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 - key: items + first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + key: rate_plans next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 - items: + url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + rate_plans: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: '1234' - failure_reason: '' + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: received - unique_name: foobar - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -4903,99 +4652,231 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersHostedNumberOrder + operationId: ListWirelessRatePlan post: - description: Host a phone number's capability on Twilio's platform. + description: '' tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewWirelessRatePlan responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.wireless.rate_plan' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 0 - capabilities: - sms: true - voice: false - cc_emails: [] - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: null - failure_reason: '' - friendly_name: null - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: null - status: received - unique_name: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: null - verification_code: null - verification_document_sid: null - verification_type: phone-call - createWithoutOptionalLoaFields: + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateWirelessRatePlan + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateWirelessRatePlanRequest + properties: + UniqueName: + type: string + description: '' + FriendlyName: + type: string + description: '' + DataEnabled: + type: boolean + description: '' + DataLimit: + type: integer + description: '' + DataMetering: + type: string + description: '' + MessagingEnabled: + type: boolean + description: '' + VoiceEnabled: + type: boolean + description: '' + CommandsEnabled: + type: boolean + description: '' + NationalRoamingEnabled: + type: boolean + description: '' + InternationalRoaming: + type: array + items: + type: string + description: '' + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 1000 + DataMetering: pooled + MessagingEnabled: true + VoiceEnabled: true + FriendlyName: friendly_name + NationalRoamingEnabled: true + InternationalRoaming: + - data + - voice + - messaging + Status: status + /wireless/RatePlans/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + get: + description: '' + tags: + - PreviewWirelessRatePlan + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: null - call_delay: 0 - capabilities: - sms: true - voice: false - cc_emails: [] - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: null - extension: null - failure_reason: '' - friendly_name: null - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: null - status: received - unique_name: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: null - verification_code: null - verification_document_sid: null - verification_type: phone-call - createWithPhoneBillVerification: + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWirelessRatePlan + post: + description: '' + tags: + - PreviewWirelessRatePlan + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: null - call_delay: 0 - capabilities: - sms: true - voice: false - cc_emails: [] - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: null - extension: null - failure_reason: '' - friendly_name: null - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: null - status: received - unique_name: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: null - verification_code: null - verification_document_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_type: phone-bill + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5021,196 +4902,101 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: Created + description: OK security: - accountSid_authToken: [] - operationId: CreateHostedNumbersHostedNumberOrder + operationId: UpdateWirelessRatePlan requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateHostedNumbersHostedNumberOrderRequest + title: UpdateWirelessRatePlanRequest 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: + description: '' + FriendlyName: 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 + description: '' examples: - create: - value: - AddressSid: AD11111111111111111111111111111111 - PhoneNumber: '+14153608311' - SmsCapability: true - Email: test@twilio.com - createWithoutOptionalLoaFields: - value: - PhoneNumber: '+14153608311' - SmsCapability: true - createWithPhoneBillVerification: + update: value: - PhoneNumber: '+14153608311' - SmsCapability: true - VerificationType: phone-bill - VerificationDocumentSid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /marketplace/AvailableAddOns/{Sid}: + UniqueName: unique_name + FriendlyName: friendly_name + delete: + description: '' + tags: + - PreviewWirelessRatePlan + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteWirelessRatePlan + /wireless/Sims/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - extensions: - mapping: - available_add_on_sid: sid - resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + usage: + mapping: + sim_sid: sid + resource_url: /wireless/Sims/{sim_sid}/Usage pathType: instance get: - description: Fetch an instance of an Add-on currently available to be installed. + description: '' tags: - - PreviewMarketplaceAvailableAddOn + - PreviewWirelessSim parameters: - name: Sid in: path - description: The SID of the AvailableAddOn resource to fetch. + description: '' 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' + $ref: '#/components/schemas/preview.wireless.sim' examples: fetch: value: - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - pricing_type: per minute - configuration_schema: - type: object - properties: - bad_words: - type: boolean - required: - - bad_words - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com links: - extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5239,24 +5025,237 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOn - /marketplace/AvailableAddOns: + operationId: FetchWirelessSim + post: + description: '' + tags: + - PreviewWirelessSim + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateWirelessSim + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateWirelessSimRequest + properties: + UniqueName: + type: string + description: '' + CallbackMethod: + type: string + description: '' + CallbackUrl: + type: string + format: uri + description: '' + FriendlyName: + type: string + description: '' + RatePlan: + type: string + description: '' + Status: + type: string + description: '' + CommandsCallbackMethod: + type: string + format: http-method + enum: + - GET + - POST + description: '' + CommandsCallbackUrl: + type: string + format: uri + description: '' + SmsFallbackMethod: + type: string + format: http-method + enum: + - GET + - POST + description: '' + SmsFallbackUrl: + type: string + format: uri + description: '' + SmsMethod: + type: string + format: http-method + enum: + - GET + - POST + description: '' + SmsUrl: + type: string + format: uri + description: '' + VoiceFallbackMethod: + type: string + format: http-method + enum: + - GET + - POST + description: '' + VoiceFallbackUrl: + type: string + format: uri + description: '' + VoiceMethod: + type: string + format: http-method + enum: + - GET + - POST + description: '' + VoiceUrl: + type: string + format: uri + description: '' + examples: + update: + value: + UniqueName: unique_name + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + CommandsCallbackMethod: http_method + CommandsCallbackUrl: http://www.example.com + VoiceMethod: http_method + VoiceUrl: http://www.example.com + VoiceFallbackMethod: http_method + VoiceFallbackUrl: http://www.example.com + SmsMethod: http_method + SmsUrl: http://www.example.com + SmsFallbackMethod: http_method + SmsFallbackUrl: http://www.example.com + FriendlyName: friendly_name + RatePlan: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Status: status + /wireless/Sims: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - extensions: + usage: mapping: - available_add_on_sid: sid - resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + sim_sid: sid + resource_url: /wireless/Sims/{sim_sid}/Usage pathType: list get: - description: Retrieve a list of Add-ons currently available to be installed. + description: '' tags: - - PreviewMarketplaceAvailableAddOn + - PreviewWirelessSim parameters: + - name: Status + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: status + readFull: + value: status + - name: Iccid + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: iccid + readFull: + value: iccid + - name: RatePlan + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: rate_plan + readFull: + value: rate_plan + - name: EId + in: query + description: '' + schema: + type: string + - name: SimRegistrationCode + in: query + description: '' + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5283,10 +5282,10 @@ paths: schema: type: object properties: - available_add_ons: + sims: type: array items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' + $ref: '#/components/schemas/preview.wireless.sim' meta: properties: first_page_url: @@ -5310,44 +5309,54 @@ paths: format: uri type: string type: object - title: ListMarketplaceAvailableAddOnResponse + title: ListWirelessSimResponse examples: - readFull: + readEmpty: value: - available_add_ons: - - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - pricing_type: per minute - configuration_schema: - type: object - properties: - bad_words: - type: boolean - required: - - bad_words - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + sims: [] meta: + first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 - next_page_url: null - key: available_add_ons - readEmpty: + url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + readFull: value: - available_add_ons: [] + sims: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: + first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 - next_page_url: null - key: available_add_ons + url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5376,55 +5385,60 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOn - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: + operationId: ListWirelessSim + /wireless/Sims/{SimSid}/Usage: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension + parent: /Sims/{Sid} pathType: instance get: - description: Fetch an instance of an Extension for the Available Add-on. + description: '' tags: - - PreviewMarketplaceAvailableAddOnExtension + - PreviewWirelessUsage parameters: - - name: AvailableAddOnSid + - name: SimSid in: path - description: The SID of the AvailableAddOn resource with the extension to - fetch. + description: '' 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. + - name: End + in: query + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - required: true + examples: + fetch: + value: end + - name: Start + in: query + description: '' + schema: + type: string + examples: + fetch: + value: start responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + $ref: '#/components/schemas/preview.wireless.sim.usage' examples: fetch: value: - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands_costs: {} + commands_usage: {} + data_costs: {} + data_usage: {} + sim_unique_name: sim_unique_name + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: {} + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5453,114 +5467,152 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOnExtension - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + operationId: FetchWirelessUsage + /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension - pathType: list + parent: /Fleets/{Sid} + pathType: instance get: - description: Retrieve a list of Extensions for the Available Add-on. + description: Fetch information about a specific Certificate credential in the + Fleet. tags: - - PreviewMarketplaceAvailableAddOnExtension + - 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' + examples: + fetch: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesCertificate + 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 + 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: AvailableAddOnSid + - name: FleetSid in: path - description: The SID of the AvailableAddOn resource with the extensions to - read. + description: '' 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. + - 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: - type: object - properties: - extensions: - type: array - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - title: ListMarketplaceAvailableAddOnExtensionResponse + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' examples: - readFull: - value: - extensions: - - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - page: 0 - page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions - readEmpty: + update: value: - extensions: [] - meta: - page: 0 - page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5589,49 +5641,68 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOnExtension - /marketplace/InstalledAddOns: + operationId: UpdateDeployedDevicesCertificate + 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. + examples: + update: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + /DeployedDevices/Fleets/{FleetSid}/Certificates: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - extensions: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions - usage: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + parent: /Fleets/{Sid} pathType: list post: - description: Install an Add-on for the Account specified. + description: Enroll a new Certificate credential to the Fleet, optionally giving + it a friendly name and assigning to a Device. tags: - - PreviewMarketplaceInstalledAddOn + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' examples: create: value: - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription_1 - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5660,45 +5731,58 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateMarketplaceInstalledAddOn + operationId: CreateDeployedDevicesCertificate requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateMarketplaceInstalledAddOnRequest + title: CreateDeployedDevicesCertificateRequest properties: - AvailableAddOnSid: + 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: ^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. + 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: - - AvailableAddOnSid - - AcceptTermsOfService + - CertificateData examples: create: value: - AvailableAddOnSid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - AcceptTermsOfService: true - Configuration: '{"bad_words": true}' - UniqueName: voicebase_high_accuracy_transcription_1 + CertificateData: 12345678abcdef + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: - description: Retrieve a list of Add-ons currently installed on this Account. + description: Retrieve a list of all Certificate credentials belonging to the + Fleet. tags: - - PreviewMarketplaceInstalledAddOn + - 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 @@ -5725,10 +5809,10 @@ paths: schema: type: object properties: - installed_add_ons: + certificates: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' meta: properties: first_page_url: @@ -5750,45 +5834,41 @@ paths: type: string url: format: uri - type: string - type: object - title: ListMarketplaceInstalledAddOnResponse - examples: - readFull: - value: - installed_add_ons: - - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: string + type: object + title: ListDeployedDevicesCertificateResponse + examples: + readEmpty: + value: + certificates: [] meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 - next_page_url: null - key: installed_add_ons - readEmpty: + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + readFull: value: - installed_add_ons: [] + certificates: + - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 - next_page_url: null - key: installed_add_ons + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5817,79 +5897,53 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOn - /marketplace/InstalledAddOns/{Sid}: + operationId: ListDeployedDevicesCertificate + /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - extensions: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions - usage: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + parent: /Fleets/{Sid} pathType: instance - delete: - description: Remove an Add-on installation from your account + get: + description: Fetch information about a specific Deployment in the Fleet. tags: - - PreviewMarketplaceInstalledAddOn + - PreviewDeployedDevicesDeployment parameters: - - name: Sid + - name: FleetSid in: path - description: The SID of the InstalledAddOn resource to delete. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteMarketplaceInstalledAddOn - get: - description: Fetch an instance of an Add-on currently installed on this Account. - tags: - - PreviewMarketplaceInstalledAddOn - parameters: - name: Sid in: path - description: The SID of the InstalledAddOn resource to fetch. + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^DL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' examples: fetch: value: - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -5918,141 +5972,75 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOn - post: - description: Update an Add-on installation for the Account specified. + operationId: FetchDeployedDevicesDeployment + delete: + description: Delete a specific Deployment from the Fleet, leaving associated + devices effectively undeployed. tags: - - PreviewMarketplaceInstalledAddOn + - PreviewDeployedDevicesDeployment parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true - name: Sid in: path - description: The SID of the InstalledAddOn resource to update. + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^DL[0-9a-fA-F]{32}$ required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - examples: - update: - value: - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription_2 - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOn - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateMarketplaceInstalledAddOnRequest - properties: - Configuration: - description: Valid JSON object that conform to the configuration - schema exposed by the associated AvailableAddOn resource. This - is only required by Add-ons that need to be configured - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - examples: - update: - value: - Configuration: '{"bad_words": true}' - UniqueName: voicebase_high_accuracy_transcription_2 - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension - pathType: instance - get: - description: Fetch an instance of an Extension for the Installed Add-on. + operationId: DeleteDeployedDevicesDeployment + 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: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewDeployedDevicesDeployment parameters: - - name: InstalledAddOnSid + - name: FleetSid in: path - description: The SID of the InstalledAddOn resource with the extension to - fetch. + description: '' 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. + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ + pattern: ^DL[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' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' examples: - fetch: + update: value: - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - enabled: true - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -6081,47 +6069,68 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOnExtension + operationId: UpdateDeployedDevicesDeployment + 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. + examples: + update: + value: + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid + /DeployedDevices/Fleets/{FleetSid}/Deployments: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Fleets/{Sid} + pathType: list post: - description: Update an Extension for an Add-on installation. + description: Create a new Deployment in the Fleet, optionally giving it a friendly + name and linking to a specific Twilio Sync service instance. tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewDeployedDevicesDeployment 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 + - name: FleetSid in: path - description: The SID of the InstalledAddOn Extension resource to update. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' examples: - update: + create: value: - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - enabled: false - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -6147,49 +6156,44 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: OK + description: Created security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOnExtension + operationId: CreateDeployedDevicesDeployment requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateMarketplaceInstalledAddOnExtensionRequest + title: CreateDeployedDevicesDeploymentRequest properties: - Enabled: - type: boolean - description: Whether the Extension should be invoked. - required: - - Enabled + 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. examples: - update: + create: value: - Enabled: false - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension - pathType: list + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid get: - description: Retrieve a list of Extensions for the Installed Add-on. + description: Retrieve a list of all Deployments belonging to the Fleet. tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewDeployedDevicesDeployment parameters: - - name: InstalledAddOnSid + - name: FleetSid in: path - description: The SID of the InstalledAddOn resource with the extensions to - read. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ required: true - name: PageSize in: query @@ -6217,10 +6221,10 @@ paths: schema: type: object properties: - extensions: + deployments: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' meta: properties: first_page_url: @@ -6244,37 +6248,38 @@ paths: format: uri type: string type: object - title: ListMarketplaceInstalledAddOnExtensionResponse + title: ListDeployedDevicesDeploymentResponse examples: - readFull: + readEmpty: value: - extensions: - - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - enabled: true - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployments: [] meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions - readEmpty: + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + readFull: value: - extensions: [] + deployments: + - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -6303,38 +6308,30 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOnExtension - /Sync/Services/{ServiceSid}/Documents/{Sid}: + operationId: ListDeployedDevicesDeployment + /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - permissions: - mapping: - service_sid: service_sid - document_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions - parent: /Services/{Sid} + parent: /Fleets/{Sid} pathType: instance get: - description: '' + description: Fetch information about a specific Device in the Fleet. tags: - - PreviewSyncDocument + - PreviewDeployedDevicesDevice parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Device resource. schema: type: string required: true @@ -6343,26 +6340,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' examples: fetch: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: - ETag: - schema: - type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -6390,24 +6384,23 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocument + operationId: FetchDeployedDevicesDevice delete: - description: '' + description: Delete a specific Device from the Fleet, also removing it from + associated Deployments. tags: - - PreviewSyncDocument + - PreviewDeployedDevicesDevice parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Device resource. schema: type: string required: true @@ -6416,57 +6409,48 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncDocument + operationId: DeleteDeployedDevicesDevice post: - description: '' + 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: - - PreviewSyncDocument + - PreviewDeployedDevicesDevice parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Device resource. schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + update: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: - ETag: - schema: - type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -6494,76 +6478,80 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocument + operationId: UpdateDeployedDevicesDevice requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentRequest + title: UpdateDeployedDevicesDeviceRequest properties: - Data: + 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: '' - required: - - Data examples: update: value: - Data: '{}' - UniqueName: unique_name - /Sync/Services/{ServiceSid}/Documents: + FriendlyName: friendly_name + Identity: identity + /DeployedDevices/Fleets/{FleetSid}/Devices: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - permissions: - mapping: - service_sid: service_sid - document_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions - parent: /Services/{Sid} + parent: /Fleets/{Sid} pathType: list post: - description: '' + 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: - - PreviewSyncDocument + - PreviewDeployedDevicesDevice parameters: - - name: ServiceSid + - name: FleetSid 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' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' examples: create: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: - ETag: - schema: - type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -6591,38 +6579,64 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateSyncDocument + operationId: CreateDeployedDevicesDevice requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncDocumentRequest + title: CreateDeployedDevicesDeviceRequest properties: UniqueName: type: string - description: '' - Data: + 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: '' examples: create: value: - Data: '{}' + FriendlyName: friendly_name UniqueName: unique_name + Identity: identity get: - description: '' + description: Retrieve a list of all Devices belonging to the Fleet. tags: - - PreviewSyncDocument + - PreviewDeployedDevicesDevice parameters: - - name: ServiceSid + - 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: ^IS[0-9a-fA-F]{32}$ - required: true + pattern: ^DL[0-9a-fA-F]{32}$ - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6649,10 +6663,10 @@ paths: schema: type: object properties: - documents: + devices: type: array items: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' meta: properties: first_page_url: @@ -6676,42 +6690,42 @@ paths: format: uri type: string type: object - title: ListSyncDocumentResponse + title: ListDeployedDevicesDeviceResponse examples: readEmpty: value: - documents: [] + devices: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 - key: documents + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 readFull: value: - documents: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + devices: + - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 - key: documents + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -6740,40 +6754,40 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocument - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + operationId: ListDeployedDevicesDevice + /DeployedDevices/Fleets/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + 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 pathType: instance get: - description: Fetch a specific Sync Document Permission. + description: Fetch information about a specific Fleet in your account. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesFleet 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 + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true @@ -6782,18 +6796,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet' examples: fetch: value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -6822,31 +6841,17 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocumentPermission + operationId: FetchDeployedDevicesFleet delete: - description: Delete a specific Sync Document Permission. + description: 'Delete a specific Fleet from your account, also destroys all nested + resources: Devices, Deployments, Certificates, Keys.' tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesFleet 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 + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true @@ -6855,31 +6860,16 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncDocumentPermission + operationId: DeleteDeployedDevicesFleet post: - description: Update an identity's access to a specific Sync Document. + description: Update the friendly name property of a specific Fleet in your account. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesFleet 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 + - name: Sid in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true @@ -6888,18 +6878,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet' examples: update: value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -6928,65 +6923,130 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocumentPermission + operationId: UpdateDeployedDevicesFleet requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentPermissionRequest + title: UpdateDeployedDevicesFleetRequest 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 + 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. examples: update: value: - Read: 'true' - Write: 'true' - Manage: 'true' - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + FriendlyName: friendly_name + DefaultDeploymentSid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /DeployedDevices/Fleets: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + 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 pathType: list + 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' + examples: + create: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesFleet + 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. + examples: + create: + value: + FriendlyName: friendly_name get: - description: Retrieve a list of all Permissions applying to a Sync Document. + description: Retrieve a list of all Fleets belonging to your account. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesFleet 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 @@ -7013,10 +7073,10 @@ paths: schema: type: object properties: - permissions: + fleets: type: array items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet' meta: properties: first_page_url: @@ -7040,38 +7100,43 @@ paths: format: uri type: string type: object - title: ListSyncDocumentPermissionResponse + title: ListDeployedDevicesFleetResponse examples: readEmpty: value: - permissions: [] + fleets: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 readFull: value: - permissions: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + fleets: + - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -7100,63 +7165,54 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocumentPermission - /Sync/Services/{Sid}: + operationId: ListDeployedDevicesFleet + /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - documents: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents - lists: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists - maps: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps + parent: /Fleets/{Sid} pathType: instance get: - description: '' + description: Fetch information about a specific Key credential in the Fleet. tags: - - PreviewSyncService + - PreviewDeployedDevicesKey parameters: - - name: Sid + - 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: ^IS[0-9a-fA-F]{32}$ + pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' examples: fetch: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name - links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: false + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -7185,63 +7241,75 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncService + operationId: FetchDeployedDevicesKey delete: - description: '' + description: Delete a specific Key credential from the Fleet, effectively disallowing + any inbound client connections that are presenting it. tags: - - PreviewSyncService + - PreviewDeployedDevicesKey parameters: - - name: Sid + - 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: ^IS[0-9a-fA-F]{32}$ + pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncService + operationId: DeleteDeployedDevicesKey post: - description: '' + description: Update the given properties of a specific Key credential in the + Fleet, giving it a friendly name or assigning to a Device. tags: - - PreviewSyncService + - PreviewDeployedDevicesKey parameters: - - name: Sid + - 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: ^IS[0-9a-fA-F]{32}$ + pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' examples: update: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name - links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: true + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -7270,79 +7338,68 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncService + operationId: UpdateDeployedDevicesKey requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncServiceRequest + title: UpdateDeployedDevicesKeyRequest properties: - WebhookUrl: - type: string - format: uri - description: '' FriendlyName: type: string - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' + 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. examples: update: value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa FriendlyName: friendly_name - WebhookUrl: http://www.example.com - AclEnabled: true - /Sync/Services: + /DeployedDevices/Fleets/{FleetSid}/Keys: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - documents: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents - lists: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists - maps: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps + parent: /Fleets/{Sid} pathType: list post: - description: '' + description: Create a new Key credential in the Fleet, optionally giving it + a friendly name and assigning to a Device. tags: - - PreviewSyncService + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' examples: create: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name - links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: true + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -7371,38 +7428,50 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateSyncService + operationId: CreateDeployedDevicesKey requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncServiceRequest + title: CreateDeployedDevicesKeyRequest properties: FriendlyName: type: string - description: '' - WebhookUrl: + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: type: string - format: uri - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' + 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. examples: create: value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa FriendlyName: friendly_name - WebhookUrl: http://www.example.com - AclEnabled: true get: - description: '' + description: Retrieve a list of all Keys credentials belonging to the Fleet. tags: - - PreviewSyncService + - 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 @@ -7429,10 +7498,10 @@ paths: schema: type: object properties: - services: + keys: type: array items: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' meta: properties: first_page_url: @@ -7456,43 +7525,39 @@ paths: format: uri type: string type: object - title: ListSyncServiceResponse + title: ListDeployedDevicesKeyResponse examples: readEmpty: value: + keys: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - key: services + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - services: [] + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 readFull: value: + keys: + - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - key: services + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - services: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: false + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -7521,31 +7586,25 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncService - /Sync/Services/{ServiceSid}/Lists/{Sid}: + operationId: ListDeployedDevicesKey + /Sync/Services/{ServiceSid}/Documents/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - items: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items permissions: mapping: service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions parent: /Services/{Sid} - mountName: sync_lists pathType: instance get: description: '' tags: - - PreviewSyncSyncList + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -7567,23 +7626,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.sync.service.document' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions headers: + ETag: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -7611,11 +7673,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncList + operationId: FetchSyncDocument delete: description: '' tags: - - PreviewSyncSyncList + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -7637,31 +7699,119 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncList - /Sync/Services/{ServiceSid}/Lists: + operationId: DeleteSyncDocument + post: + description: '' + tags: + - PreviewSyncDocument + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + headers: + ETag: + schema: + type: string + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateSyncDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncDocumentRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + UniqueName: unique_name + /Sync/Services/{ServiceSid}/Documents: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - 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 + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions parent: /Services/{Sid} - mountName: sync_lists pathType: list post: description: '' tags: - - PreviewSyncSyncList + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -7677,23 +7827,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.sync.service.document' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions headers: + ETag: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -7721,25 +7874,28 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncList + operationId: CreateSyncDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncListRequest + title: CreateSyncDocumentRequest properties: UniqueName: type: string description: '' + Data: + description: '' examples: create: value: + Data: '{}' UniqueName: unique_name get: description: '' tags: - - PreviewSyncSyncList + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -7776,10 +7932,10 @@ paths: schema: type: object properties: - lists: + documents: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.sync.service.document' meta: properties: first_page_url: @@ -7803,42 +7959,42 @@ paths: format: uri type: string type: object - title: ListSyncSyncListResponse + title: ListSyncDocumentResponse examples: readEmpty: value: - lists: [] + documents: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 - key: lists + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 readFull: value: - lists: + documents: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 - key: lists + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -7867,20 +8023,20 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncList - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + operationId: ListSyncDocument + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions pathType: instance get: - description: '' + description: Fetch a specific Sync Document Permission. tags: - - PreviewSyncSyncListItem + - PreviewSyncDocumentPermission parameters: - name: ServiceSid in: path @@ -7891,41 +8047,37 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: Index + - name: Identity in: path - description: '' + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: - type: integer + type: string required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity headers: - ETag: - schema: - type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -7953,11 +8105,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListItem + operationId: FetchSyncDocumentPermission delete: - description: '' + description: Delete a specific Sync Document Permission. tags: - - PreviewSyncSyncListItem + - PreviewSyncDocumentPermission parameters: - name: ServiceSid in: path @@ -7968,83 +8120,70 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: Index + - name: Identity in: path - description: '' - schema: - type: integer - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header + 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: DeleteSyncSyncListItem + operationId: DeleteSyncDocumentPermission post: - description: '' + description: Update an identity's access to a specific Sync Document. tags: - - PreviewSyncSyncListItem + - PreviewSyncDocumentPermission parameters: - name: ServiceSid in: path - description: '' + 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 + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: Index + - name: Identity in: path - description: '' - schema: - type: integer - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header + 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_item' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity headers: - ETag: - schema: - type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -8072,121 +8211,49 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListItem + operationId: UpdateSyncDocumentPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListItemRequest + title: UpdateSyncDocumentPermissionRequest properties: - Data: - description: '' + 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: - - Data + - Read + - Write + - Manage examples: update: value: - Data: '{}' - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions pathType: list - post: - description: '' - tags: - - PreviewSyncSyncListItem - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 - headers: - ETag: - schema: - type: string - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncSyncListItem - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncSyncListItemRequest - properties: - Data: - description: '' - required: - - Data - examples: - create: - value: - Data: '{}' get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync Document. tags: - - PreviewSyncSyncListItem + - PreviewSyncDocumentPermission parameters: - name: ServiceSid in: path @@ -8197,44 +8264,12 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_list_item_enum_query_result_order' - examples: - readEmpty: - value: asc - readFull: - value: asc - - name: From - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: from - readFull: - value: from - - name: Bounds - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' - examples: - readEmpty: - value: inclusive - readFull: - value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8261,10 +8296,10 @@ paths: schema: type: object properties: - items: + permissions: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' meta: properties: first_page_url: @@ -8288,40 +8323,38 @@ paths: format: uri type: string type: object - title: ListSyncSyncListItemResponse + title: ListSyncDocumentPermissionResponse examples: readEmpty: value: - items: [] - meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 - key: items + permissions: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 readFull: value: - items: + permissions: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 - key: items + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -8350,22 +8383,33 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListItem - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + operationId: ListSyncDocumentPermission + /Sync/Services/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps pathType: instance get: - description: Fetch a specific Sync List Permission. + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewSyncService parameters: - - name: ServiceSid + - name: Sid in: path description: '' schema: @@ -8374,36 +8418,28 @@ paths: 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' + $ref: '#/components/schemas/preview.sync.service' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -8432,13 +8468,13 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListPermission + operationId: FetchSyncService delete: - description: Delete a specific Sync List Permission. + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewSyncService parameters: - - name: ServiceSid + - name: Sid in: path description: '' schema: @@ -8447,69 +8483,48 @@ paths: 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 + operationId: DeleteSyncService post: - description: Update an identity's access to a specific Sync List. + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewSyncService parameters: - - name: ServiceSid + - name: Sid in: path - description: The unique SID identifier of the Sync Service Instance. + 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 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' + $ref: '#/components/schemas/preview.sync.service' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -8538,65 +8553,139 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListPermission + operationId: UpdateSyncService requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListPermissionRequest + title: UpdateSyncServiceRequest properties: - Read: + WebhookUrl: + type: string + format: uri + description: '' + FriendlyName: + type: string + description: '' + ReachabilityWebhooksEnabled: type: boolean - description: Boolean flag specifying whether the identity can read - the Sync List. - Write: + description: '' + AclEnabled: + type: boolean + description: '' + examples: + update: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + /Sync/Services: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps + pathType: list + post: + description: '' + tags: + - PreviewSyncService + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncService + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncServiceRequest + properties: + FriendlyName: + type: string + description: '' + WebhookUrl: + type: string + format: uri + description: '' + ReachabilityWebhooksEnabled: type: boolean - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync List. - Manage: + description: '' + AclEnabled: type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync List. - required: - - Read - - Write - - Manage + description: '' examples: - update: + create: value: - Read: 'true' - Write: 'true' - Manage: 'true' - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions - pathType: list + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true get: - description: Retrieve a list of all Permissions applying to a Sync List. + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewSyncService 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 @@ -8623,10 +8712,10 @@ paths: schema: type: object properties: - permissions: + services: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.sync.service' meta: properties: first_page_url: @@ -8650,38 +8739,43 @@ paths: format: uri type: string type: object - title: ListSyncSyncListPermissionResponse + title: ListSyncServiceResponse examples: readEmpty: value: - permissions: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: [] readFull: value: - permissions: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -8710,8 +8804,8 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListPermission - /Sync/Services/{ServiceSid}/Maps/{Sid}: + operationId: ListSyncService + /Sync/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://preview.twilio.com description: '' @@ -8721,20 +8815,20 @@ paths: items: mapping: service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items permissions: mapping: service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions parent: /Services/{Sid} - mountName: sync_maps + mountName: sync_lists pathType: instance get: description: '' tags: - - PreviewSyncSyncMap + - PreviewSyncSyncList parameters: - name: ServiceSid in: path @@ -8756,7 +8850,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.sync.service.sync_list' examples: fetch: value: @@ -8765,13 +8859,13 @@ paths: date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -8800,11 +8894,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMap + operationId: FetchSyncSyncList delete: description: '' tags: - - PreviewSyncSyncMap + - PreviewSyncSyncList parameters: - name: ServiceSid in: path @@ -8826,8 +8920,8 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMap - /Sync/Services/{ServiceSid}/Maps: + operationId: DeleteSyncSyncList + /Sync/Services/{ServiceSid}/Lists: servers: - url: https://preview.twilio.com description: '' @@ -8837,20 +8931,20 @@ paths: items: mapping: service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items permissions: mapping: service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions parent: /Services/{Sid} - mountName: sync_maps + mountName: sync_lists pathType: list post: description: '' tags: - - PreviewSyncSyncMap + - PreviewSyncSyncList parameters: - name: ServiceSid in: path @@ -8866,7 +8960,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.sync.service.sync_list' examples: create: value: @@ -8875,13 +8969,13 @@ paths: date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -8910,13 +9004,13 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncMap + operationId: CreateSyncSyncList requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapRequest + title: CreateSyncSyncListRequest properties: UniqueName: type: string @@ -8928,7 +9022,7 @@ paths: get: description: '' tags: - - PreviewSyncSyncMap + - PreviewSyncSyncList parameters: - name: ServiceSid in: path @@ -8965,10 +9059,10 @@ paths: schema: type: object properties: - maps: + lists: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.sync.service.sync_list' meta: properties: first_page_url: @@ -8992,42 +9086,42 @@ paths: format: uri type: string type: object - title: ListSyncSyncMapResponse + title: ListSyncSyncListResponse examples: readEmpty: value: - maps: [] + lists: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 - key: maps + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 readFull: value: - maps: + lists: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 - key: maps + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -9056,20 +9150,20 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMap - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + operationId: ListSyncSyncList + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items pathType: instance get: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewSyncSyncListItem parameters: - name: ServiceSid in: path @@ -9080,24 +9174,24 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: type: string required: true - - name: Key + - name: Index in: path description: '' schema: - type: string + type: integer required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' examples: fetch: value: @@ -9106,11 +9200,11 @@ paths: data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 headers: ETag: schema: @@ -9142,11 +9236,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapItem + operationId: FetchSyncSyncListItem delete: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewSyncSyncListItem parameters: - name: ServiceSid in: path @@ -9157,17 +9251,17 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: type: string required: true - - name: Key + - name: Index in: path description: '' schema: - type: string + type: integer required: true - name: If-Match in: header @@ -9179,11 +9273,11 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapItem + operationId: DeleteSyncSyncListItem post: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewSyncSyncListItem parameters: - name: ServiceSid in: path @@ -9194,17 +9288,17 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: type: string required: true - - name: Key + - name: Index in: path description: '' schema: - type: string + type: integer required: true - name: If-Match in: header @@ -9216,7 +9310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' examples: update: value: @@ -9225,11 +9319,11 @@ paths: data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 headers: ETag: schema: @@ -9261,13 +9355,13 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapItem + operationId: UpdateSyncSyncListItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapItemRequest + title: UpdateSyncSyncListItemRequest properties: Data: description: '' @@ -9277,19 +9371,19 @@ paths: update: value: Data: '{}' - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items pathType: list post: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewSyncSyncListItem parameters: - name: ServiceSid in: path @@ -9300,7 +9394,7 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: @@ -9311,7 +9405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' examples: create: value: @@ -9320,11 +9414,11 @@ paths: data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 headers: ETag: schema: @@ -9356,31 +9450,26 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncMapItem + operationId: CreateSyncSyncListItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapItemRequest + title: CreateSyncSyncListItemRequest properties: - Key: - type: string - description: '' Data: description: '' required: - - Key - Data examples: create: value: Data: '{}' - Key: key get: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewSyncSyncListItem parameters: - name: ServiceSid in: path @@ -9391,7 +9480,7 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: @@ -9402,7 +9491,7 @@ paths: description: '' schema: type: string - $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + $ref: '#/components/schemas/sync_list_item_enum_query_result_order' examples: readEmpty: value: asc @@ -9423,7 +9512,7 @@ paths: description: '' schema: type: string - $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' examples: readEmpty: value: inclusive @@ -9458,7 +9547,7 @@ paths: items: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' meta: properties: first_page_url: @@ -9482,19 +9571,19 @@ paths: format: uri type: string type: object - title: ListSyncSyncMapItemResponse + title: ListSyncSyncListItemResponse examples: readEmpty: value: items: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 readFull: value: items: @@ -9503,19 +9592,19 @@ paths: data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -9544,20 +9633,20 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapItem - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + operationId: ListSyncSyncListItem + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: instance get: - description: Fetch a specific Sync Map Permission. + description: Fetch a specific Sync List Permission. tags: - - PreviewSyncSyncMapPermission + - PreviewSyncSyncListPermission parameters: - name: ServiceSid in: path @@ -9568,9 +9657,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true @@ -9586,18 +9675,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: identity read: true write: true manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -9626,11 +9715,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapPermission + operationId: FetchSyncSyncListPermission delete: - description: Delete a specific Sync Map Permission. + description: Delete a specific Sync List Permission. tags: - - PreviewSyncSyncMapPermission + - PreviewSyncSyncListPermission parameters: - name: ServiceSid in: path @@ -9641,9 +9730,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true @@ -9659,11 +9748,11 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapPermission + operationId: DeleteSyncSyncListPermission post: - description: Update an identity's access to a specific Sync Map. + description: Update an identity's access to a specific Sync List. tags: - - PreviewSyncSyncMapPermission + - PreviewSyncSyncListPermission parameters: - name: ServiceSid in: path @@ -9674,9 +9763,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true @@ -9692,18 +9781,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: identity read: true write: true manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -9732,26 +9821,26 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapPermission + operationId: UpdateSyncSyncListPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapPermissionRequest + title: UpdateSyncSyncListPermissionRequest properties: Read: type: boolean description: Boolean flag specifying whether the identity can read - the Sync Map. + the Sync List. Write: type: boolean description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync Map. + update and delete Items of the Sync List. Manage: type: boolean description: Boolean flag specifying whether the identity can delete - the Sync Map. + the Sync List. required: - Read - Write @@ -9762,19 +9851,19 @@ paths: Read: 'true' Write: 'true' Manage: 'true' - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: list get: - description: Retrieve a list of all Permissions applying to a Sync Map. + description: Retrieve a list of all Permissions applying to a Sync List. tags: - - PreviewSyncSyncMapPermission + - PreviewSyncSyncListPermission parameters: - name: ServiceSid in: path @@ -9785,9 +9874,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true @@ -9820,7 +9909,7 @@ paths: permissions: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' meta: properties: first_page_url: @@ -9844,38 +9933,38 @@ paths: format: uri type: string type: object - title: ListSyncSyncMapPermissionResponse + title: ListSyncSyncListPermissionResponse examples: readEmpty: value: permissions: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 readFull: value: permissions: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: identity read: true write: true manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -9904,217 +9993,68 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapPermission - /wireless/Commands/{Sid}: + operationId: ListSyncSyncListPermission + /Sync/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps pathType: instance get: description: '' tags: - - PreviewWirelessCommand - parameters: - - name: Sid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.command' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - command: command - command_mode: command_mode - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - direction: direction - sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: status - url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: FetchWirelessCommand - /wireless/Commands: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: list - get: - description: '' - tags: - - PreviewWirelessCommand + - PreviewSyncSyncMap parameters: - - name: Device - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: device - readFull: - value: device - - name: Sim - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: sim - readFull: - value: sim - - name: Status - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: status - readFull: - value: status - - name: Direction - in: query + - name: ServiceSid + in: path description: '' schema: type: string - examples: - readEmpty: - value: direction - readFull: - value: direction - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. + 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: - type: object - properties: - commands: - type: array - items: - $ref: '#/components/schemas/preview.wireless.command' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - title: ListWirelessCommandResponse + $ref: '#/components/schemas/preview.sync.service.sync_map' examples: - readEmpty: - value: - commands: [] - meta: - first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 - key: commands - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 - readFull: + fetch: value: - commands: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - command: command - command_mode: command_mode - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - direction: direction - sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: status - url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 - key: commands - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -10143,31 +10083,88 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListWirelessCommand + operationId: FetchSyncSyncMap + delete: + description: '' + tags: + - PreviewSyncSyncMap + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncMap + /Sync/Services/{ServiceSid}/Maps: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps + pathType: list post: description: '' tags: - - PreviewWirelessCommand + - 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.wireless.command' + $ref: '#/components/schemas/preview.sync.service.sync_map' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - command: command - command_mode: command_mode + created_by: created_by date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - direction: direction - sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: status - url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -10196,60 +10193,35 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateWirelessCommand + operationId: CreateSyncSyncMap requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateWirelessCommandRequest + title: CreateSyncSyncMapRequest 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: + UniqueName: type: string description: '' - required: - - Command examples: create: value: - CallbackMethod: callback_method - CallbackUrl: http://www.example.com - Command: command - CommandMode: command_mode - Device: device - Sim: sim - IncludeSid: include_sid - /wireless/RatePlans: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: list + UniqueName: unique_name get: description: '' tags: - - PreviewWirelessRatePlan + - 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 @@ -10276,10 +10248,10 @@ paths: schema: type: object properties: - rate_plans: + maps: type: array items: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.sync.service.sync_map' meta: properties: first_page_url: @@ -10303,47 +10275,42 @@ paths: format: uri type: string type: object - title: ListWirelessRatePlanResponse + title: ListSyncSyncMapResponse examples: readEmpty: value: + maps: [] meta: - first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 - key: rate_plans + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 - rate_plans: [] + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 readFull: value: + maps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 - key: rate_plans + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 - rate_plans: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - data_enabled: true - data_limit: 1000 - data_metering: pooled - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - messaging_enabled: true - voice_enabled: true - national_roaming_enabled: true - international_roaming: - - data - - messaging - - voice - sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -10372,38 +10339,65 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListWirelessRatePlan - post: + operationId: ListSyncSyncMap + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items + pathType: instance + get: description: '' tags: - - PreviewWirelessRatePlan + - 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' examples: - create: + fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - data_enabled: true - data_limit: 1000 - data_metering: pooled + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - messaging_enabled: true - voice_enabled: true - national_roaming_enabled: true - international_roaming: - - data - - messaging - - voice - sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key headers: + ETag: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -10428,110 +10422,101 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: Created + description: OK security: - accountSid_authToken: [] - operationId: CreateWirelessRatePlan - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateWirelessRatePlanRequest - properties: - UniqueName: - type: string - description: '' - FriendlyName: - type: string - description: '' - DataEnabled: - type: boolean - description: '' - DataLimit: - type: integer - description: '' - DataMetering: - type: string - description: '' - MessagingEnabled: - type: boolean - description: '' - VoiceEnabled: - type: boolean - description: '' - CommandsEnabled: - type: boolean - description: '' - NationalRoamingEnabled: - type: boolean - description: '' - InternationalRoaming: - type: array - items: - type: string - description: '' - examples: - create: - value: - UniqueName: unique_name - DataEnabled: true - DataLimit: 1000 - DataMetering: pooled - MessagingEnabled: true - VoiceEnabled: true - FriendlyName: friendly_name - NationalRoamingEnabled: true - InternationalRoaming: - - data - - voice - - messaging - Status: status - /wireless/RatePlans/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: instance - get: + operationId: FetchSyncSyncMapItem + delete: description: '' tags: - - PreviewWirelessRatePlan + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key + in: path + description: '' + schema: + type: string + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncMapItem + post: + description: '' + tags: + - PreviewSyncSyncMapItem + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key in: path description: '' schema: type: string required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' examples: - fetch: + update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - data_enabled: true - data_limit: 1000 - data_metering: pooled + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - messaging_enabled: true - voice_enabled: true - national_roaming_enabled: true - international_roaming: - - data - - messaging - - voice - sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key headers: + ETag: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -10559,45 +10544,74 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchWirelessRatePlan + operationId: UpdateSyncSyncMapItem + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncMapItemRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items + pathType: list post: description: '' tags: - - PreviewWirelessRatePlan + - PreviewSyncSyncMapItem parameters: - - name: Sid + - 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: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' examples: - update: + create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - data_enabled: true - data_limit: 1000 - data_metering: pooled + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - messaging_enabled: true - voice_enabled: true - national_roaming_enabled: true - international_roaming: - - data - - messaging - - voice - sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key headers: + ETag: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -10622,65 +10636,231 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: OK + description: Created security: - accountSid_authToken: [] - operationId: UpdateWirelessRatePlan + operationId: CreateSyncSyncMapItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateWirelessRatePlanRequest + title: CreateSyncSyncMapItemRequest properties: - UniqueName: + Key: type: string description: '' - FriendlyName: - type: string + Data: description: '' + required: + - Key + - Data examples: - update: + create: value: - UniqueName: unique_name - FriendlyName: friendly_name - delete: + Data: '{}' + Key: key + get: description: '' tags: - - PreviewWirelessRatePlan + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid in: path description: '' schema: type: string required: true + - name: Order + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc + - name: From + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: from + readFull: + value: from + - name: Bounds + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + title: ListSyncSyncMapItemResponse + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK security: - - accountSid_authToken: [] - operationId: DeleteWirelessRatePlan - /wireless/Sims/{Sid}: + - accountSid_authToken: [] + operationId: ListSyncSyncMapItem + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - usage: - mapping: - sim_sid: sid - resource_url: /wireless/Sims/{sim_sid}/Usage + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions pathType: instance get: - description: '' + description: Fetch a specific Sync Map Permission. tags: - - PreviewWirelessSim + - PreviewSyncSyncMapPermission parameters: - - name: Sid + - 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 @@ -10689,34 +10869,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - commands_callback_method: http_method - commands_callback_url: http://www.example.com - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - sms_fallback_method: http_method - sms_fallback_url: http://www.example.com - sms_method: http_method - sms_url: http://www.example.com - voice_fallback_method: http_method - voice_fallback_url: http://www.example.com - voice_method: http_method - voice_url: http://www.example.com - links: - usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage - rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - iccid: iccid - e_id: e_id - status: status - url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -10745,15 +10909,64 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchWirelessSim - post: - description: '' + operationId: FetchSyncSyncMapPermission + delete: + description: Delete a specific Sync Map Permission. tags: - - PreviewWirelessSim + - PreviewSyncSyncMapPermission parameters: - - name: Sid + - name: ServiceSid in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncMapPermission + post: + description: Update an identity's access to a specific Sync Map. + tags: + - PreviewSyncSyncMapPermission + parameters: + - name: ServiceSid + in: path + description: The unique SID identifier of the Sync Service Instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string required: true @@ -10762,34 +10975,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - commands_callback_method: http_method - commands_callback_url: http://www.example.com - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - links: - usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage - rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - iccid: iccid - e_id: e_id - status: status - sms_fallback_method: http_method - sms_fallback_url: http://www.example.com - sms_method: http_method - sms_url: http://www.example.com - voice_fallback_method: http_method - voice_fallback_url: http://www.example.com - voice_method: http_method - voice_url: http://www.example.com - url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -10799,183 +10996,84 @@ paths: Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateWirelessSim - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateWirelessSimRequest - properties: - UniqueName: - type: string - description: '' - CallbackMethod: - type: string - description: '' - CallbackUrl: - type: string - format: uri - description: '' - FriendlyName: - type: string - description: '' - RatePlan: - type: string - description: '' - Status: - type: string - description: '' - CommandsCallbackMethod: - type: string - format: http-method - enum: - - GET - - POST - description: '' - CommandsCallbackUrl: - type: string - format: uri - description: '' - SmsFallbackMethod: - type: string - format: http-method - enum: - - GET - - POST - description: '' - SmsFallbackUrl: - type: string - format: uri - description: '' - SmsMethod: - type: string - format: http-method - enum: - - GET - - POST - description: '' - SmsUrl: - type: string - format: uri - description: '' - VoiceFallbackMethod: - type: string - format: http-method - enum: - - GET - - POST - description: '' - VoiceFallbackUrl: - type: string - format: uri - description: '' - VoiceMethod: - type: string - format: http-method - enum: - - GET - - POST - description: '' - VoiceUrl: - type: string - format: uri - description: '' + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateSyncSyncMapPermission + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncMapPermissionRequest + properties: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync Map. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync Map. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Map. + required: + - Read + - Write + - Manage examples: update: value: - UniqueName: unique_name - CallbackMethod: callback_method - CallbackUrl: http://www.example.com - CommandsCallbackMethod: http_method - CommandsCallbackUrl: http://www.example.com - VoiceMethod: http_method - VoiceUrl: http://www.example.com - VoiceFallbackMethod: http_method - VoiceFallbackUrl: http://www.example.com - SmsMethod: http_method - SmsUrl: http://www.example.com - SmsFallbackMethod: http_method - SmsFallbackUrl: http://www.example.com - FriendlyName: friendly_name - RatePlan: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - Status: status - /wireless/Sims: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - usage: - mapping: - sim_sid: sid - resource_url: /wireless/Sims/{sim_sid}/Usage + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions pathType: list get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync Map. tags: - - PreviewWirelessSim + - PreviewSyncSyncMapPermission parameters: - - name: Status - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: status - readFull: - value: status - - name: Iccid - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: iccid - readFull: - value: iccid - - name: RatePlan - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: rate_plan - readFull: - value: rate_plan - - name: EId - in: query + - name: ServiceSid + in: path description: '' schema: type: string - - name: SimRegistrationCode - in: query - description: '' + 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 @@ -11002,10 +11100,10 @@ paths: schema: type: object properties: - sims: + permissions: type: array items: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' meta: properties: first_page_url: @@ -11029,136 +11127,38 @@ paths: format: uri type: string type: object - title: ListWirelessSimResponse + title: ListSyncSyncMapPermissionResponse examples: readEmpty: value: - sims: [] + permissions: [] meta: - first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 - key: sims + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 readFull: value: - sims: + permissions: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - commands_callback_method: http_method - commands_callback_url: http://www.example.com - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - links: - usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage - rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - iccid: iccid - e_id: e_id - status: status - sms_fallback_method: http_method - sms_fallback_url: http://www.example.com - sms_method: http_method - sms_url: http://www.example.com - voice_fallback_method: http_method - voice_fallback_url: http://www.example.com - voice_method: http_method - voice_url: http://www.example.com - url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 - key: sims + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: ListWirelessSim - /wireless/Sims/{SimSid}/Usage: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Sims/{Sid} - pathType: instance - get: - description: '' - tags: - - PreviewWirelessUsage - parameters: - - name: SimSid - in: path - description: '' - schema: - type: string - required: true - - name: End - in: query - description: '' - schema: - type: string - examples: - fetch: - value: end - - name: Start - in: query - description: '' - schema: - type: string - examples: - fetch: - value: start - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim.usage' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - commands_costs: {} - commands_usage: {} - data_costs: {} - data_usage: {} - sim_unique_name: sim_unique_name - sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - period: {} - url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -11187,14 +11187,12 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchWirelessUsage + operationId: ListSyncSyncMapPermission servers: - url: https://preview.twilio.com tags: -- name: PreviewDeployedDevicesCertificate -- name: PreviewDeployedDevicesDeployment -- name: PreviewDeployedDevicesDevice -- name: PreviewDeployedDevicesFleet -- name: PreviewDeployedDevicesKey +- name: PreviewHostedNumbersAuthorizationDocument +- name: PreviewHostedNumbersDependentHostedNumberOrder +- name: PreviewHostedNumbersHostedNumberOrder security: - accountSid_authToken: [] From 24e7e853093204c47f9328c436e985137cbc5751 Mon Sep 17 00:00:00 2001 From: sbansla Date: Thu, 12 Sep 2024 18:20:26 +0530 Subject: [PATCH 2/2] pr-23 changes --- spec/json/twilio_marketplace_v1.json | 112 --------------------------- spec/yaml/twilio_marketplace_v1.yaml | 74 ------------------ 2 files changed, 186 deletions(-) diff --git a/spec/json/twilio_marketplace_v1.json b/spec/json/twilio_marketplace_v1.json index 7395ff2e..6a8eba5a 100644 --- a/spec/json/twilio_marketplace_v1.json +++ b/spec/json/twilio_marketplace_v1.json @@ -2354,118 +2354,6 @@ } } }, - "/v1/ReferralRecords": { - "servers": [ - { - "url": "https://marketplace.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance" - } - }, - "/v1/ReferralRecords/{ReferralRecordSid}": { - "servers": [ - { - "url": "https://marketplace.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance" - }, - "get": { - "description": "Retrieve a referral record instance.", - "tags": [ - "MarketplaceReferralRecords" - ], - "parameters": [ - { - "name": "ReferralRecordSid", - "in": "path", - "description": "The SID of the Referral Record resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/marketplace.v1.referral_records" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "net_revenue": 1023.42, - "filename": "myfile.pdf", - "documentation_link": "https://somelink.com", - "date_created": "2024-07-31T18:51:03Z", - "date_updated": "2024-07-31T18:51:03Z", - "url": "https://marketplace.twilio.com/v1/ReferralRecords/XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "headers": { - "Access-Control-Allow-Origin": { - "description": "Specify the origin(s) allowed to access the resource", - "schema": { - "type": "string" - }, - "example": "*" - }, - "Access-Control-Allow-Methods": { - "description": "Specify the HTTP methods allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "POST, OPTIONS" - }, - "Access-Control-Allow-Headers": { - "description": "Specify the headers allowed when accessing the resource", - "schema": { - "type": "string" - }, - "example": "Content-Type, Authorization" - }, - "Access-Control-Allow-Credentials": { - "description": "Indicates whether the browser should include credentials", - "schema": { - "type": "boolean" - } - }, - "Access-Control-Expose-Headers": { - "description": "Headers exposed to the client", - "schema": { - "type": "string", - "example": "X-Custom-Header1, X-Custom-Header2" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchReferralRecords" - } - }, "/v1/Listing/{Sid}": { "servers": [ { diff --git a/spec/yaml/twilio_marketplace_v1.yaml b/spec/yaml/twilio_marketplace_v1.yaml index b8574ac6..f1e08e21 100644 --- a/spec/yaml/twilio_marketplace_v1.yaml +++ b/spec/yaml/twilio_marketplace_v1.yaml @@ -1666,80 +1666,6 @@ paths: create: value: referral_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /v1/ReferralRecords: - servers: - - url: https://marketplace.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: instance - /v1/ReferralRecords/{ReferralRecordSid}: - servers: - - url: https://marketplace.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: instance - get: - description: Retrieve a referral record instance. - tags: - - MarketplaceReferralRecords - parameters: - - name: ReferralRecordSid - in: path - description: The SID of the Referral Record resource to fetch. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XL[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/marketplace.v1.referral_records' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - net_revenue: 1023.42 - filename: myfile.pdf - documentation_link: https://somelink.com - date_created: '2024-07-31T18:51:03Z' - date_updated: '2024-07-31T18:51:03Z' - url: https://marketplace.twilio.com/v1/ReferralRecords/XLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - headers: - Access-Control-Allow-Origin: - description: Specify the origin(s) allowed to access the resource - schema: - type: string - example: '*' - Access-Control-Allow-Methods: - description: Specify the HTTP methods allowed when accessing the resource - schema: - type: string - example: POST, OPTIONS - Access-Control-Allow-Headers: - description: Specify the headers allowed when accessing the resource - schema: - type: string - example: Content-Type, Authorization - Access-Control-Allow-Credentials: - description: Indicates whether the browser should include credentials - schema: - type: boolean - Access-Control-Expose-Headers: - description: Headers exposed to the client - schema: - type: string - example: X-Custom-Header1, X-Custom-Header2 - description: OK - security: - - accountSid_authToken: [] - operationId: FetchReferralRecords /v1/Listing/{Sid}: servers: - url: https://marketplace.twilio.com