From 4c0f97a0b78a59d1dd8e8b9228bb28d74e967637 Mon Sep 17 00:00:00 2001 From: sbansla Date: Wed, 21 Aug 2024 10:48:59 +0530 Subject: [PATCH] docs team approval --- spec/json/twilio_api_v2010.json | 2592 ++--- spec/json/twilio_bulkexports_v1.json | 1 + spec/json/twilio_chat_v1.json | 6 + spec/json/twilio_chat_v2.json | 8 + spec/json/twilio_chat_v3.json | 2 + spec/json/twilio_content_sdk.json | 88 +- spec/json/twilio_conversations_v1.json | 4 + spec/json/twilio_events_v1.json | 3 + spec/json/twilio_flex_v1.json | 16 + spec/json/twilio_flex_v2.json | 180 +- spec/json/twilio_iam_organizations.json | 2 +- spec/json/twilio_insights_v1.json | 153 +- spec/json/twilio_intelligence_v2.json | 276 +- spec/json/twilio_ip_messaging_v1.json | 6 + spec/json/twilio_ip_messaging_v2.json | 8 + spec/json/twilio_marketplace_v1.json | 330 +- spec/json/twilio_messaging_v1.json | 252 +- spec/json/twilio_notify_v1.json | 1 + spec/json/twilio_numbers_v1.json | 314 +- spec/json/twilio_numbers_v2.json | 5 + spec/json/twilio_preview.json | 11922 +++++++++++----------- spec/json/twilio_proxy_v1.json | 3 + spec/json/twilio_studio_v1.json | 1 + spec/json/twilio_studio_v2.json | 2 + spec/json/twilio_supersim_v1.json | 2 + spec/json/twilio_sync_v1.json | 2 + spec/json/twilio_taskrouter_v1.json | 68 +- spec/json/twilio_trunking_v1.json | 2 + spec/json/twilio_trusthub_v1.json | 37 + spec/json/twilio_verify_v2.json | 14 +- spec/json/twilio_video_v1.json | 6 + spec/json/twilio_voice_v1.json | 4 + spec/json/twilio_wireless_v1.json | 5 + spec/yaml/twilio_api_v2010.yaml | 1248 +-- spec/yaml/twilio_bulkexports_v1.yaml | 1 + spec/yaml/twilio_chat_v1.yaml | 6 + spec/yaml/twilio_chat_v2.yaml | 8 + spec/yaml/twilio_chat_v3.yaml | 2 + spec/yaml/twilio_content_sdk.yaml | 64 +- spec/yaml/twilio_conversations_v1.yaml | 4 + spec/yaml/twilio_events_v1.yaml | 3 + spec/yaml/twilio_flex_v1.yaml | 10 + spec/yaml/twilio_flex_v2.yaml | 130 +- spec/yaml/twilio_iam_organizations.yaml | 2 +- spec/yaml/twilio_insights_v1.yaml | 131 +- spec/yaml/twilio_intelligence_v2.yaml | 169 +- spec/yaml/twilio_ip_messaging_v1.yaml | 6 + spec/yaml/twilio_ip_messaging_v2.yaml | 8 + spec/yaml/twilio_marketplace_v1.yaml | 229 +- spec/yaml/twilio_messaging_v1.yaml | 188 +- spec/yaml/twilio_notify_v1.yaml | 1 + spec/yaml/twilio_numbers_v1.yaml | 319 +- spec/yaml/twilio_numbers_v2.yaml | 5 + spec/yaml/twilio_preview.yaml | 10192 +++++++++--------- spec/yaml/twilio_proxy_v1.yaml | 3 + spec/yaml/twilio_studio_v1.yaml | 1 + spec/yaml/twilio_studio_v2.yaml | 2 + spec/yaml/twilio_supersim_v1.yaml | 2 + spec/yaml/twilio_sync_v1.yaml | 2 + spec/yaml/twilio_taskrouter_v1.yaml | 85 +- spec/yaml/twilio_trunking_v1.yaml | 2 + spec/yaml/twilio_trusthub_v1.yaml | 27 + spec/yaml/twilio_verify_v2.yaml | 16 +- spec/yaml/twilio_video_v1.yaml | 6 + spec/yaml/twilio_voice_v1.yaml | 4 + spec/yaml/twilio_wireless_v1.yaml | 5 + 66 files changed, 15439 insertions(+), 13757 deletions(-) diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 2aa0d170..1356db8f 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -1653,6 +1653,7 @@ }, "channels": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of channels in the final recording file. Can be: `1`, or `2`. Separating a two leg call into two separate channels of the recording file is supported in [Dial](https://www.twilio.com/docs/voice/twiml/dial#attributes-record) and [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls) record options." }, @@ -1882,6 +1883,7 @@ }, "channels": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of channels in the final recording file. Can be: `1`, or `2`. Separating a two leg call into two separate channels of the recording file is supported in [Dial](https://www.twilio.com/docs/voice/twiml/dial#attributes-record) and [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls) record options." }, @@ -3680,6 +3682,7 @@ }, "position": { "type": "integer", + "default": 0, "nullable": true, "description": "This member's current position in the queue." }, @@ -3690,6 +3693,7 @@ }, "wait_time": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of seconds the member has been in the queue." }, @@ -3765,7 +3769,7 @@ "error_message": { "type": "string", "nullable": true, - "description": "The description of the `error_code` if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`." + "description": "The description of the `error_code` if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`. The value returned in this field for a specific error cause is subject to change as Twilio improves errors. Users should not use the `error_code` and `error_message` fields programmatically." }, "uri": { "type": "string", @@ -3822,7 +3826,7 @@ "error_code": { "type": "integer", "nullable": true, - "description": "The [error code](https://www.twilio.com/docs/api/errors) returned if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`." + "description": "The [error code](https://www.twilio.com/docs/api/errors) returned if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`. The value returned in this field for a specific error cause is subject to change as Twilio improves errors. Users should not use the `error_code` and `error_message` fields programmatically." }, "price_unit": { "type": "string", @@ -4510,6 +4514,7 @@ }, "current_size": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of calls currently in the queue." }, @@ -4533,6 +4538,7 @@ }, "average_wait_time": { "type": "integer", + "default": 0, "nullable": true, "description": " The average wait time in seconds of the members in this queue. This is calculated at the time of the request." }, @@ -4552,6 +4558,7 @@ }, "max_size": { "type": "integer", + "default": 0, "nullable": true, "description": " The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000." } @@ -4709,6 +4716,7 @@ }, "channels": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of channels in the final recording file. Can be: `1` or `2`." }, @@ -4939,6 +4947,17 @@ } } }, + "api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload.recording_add_on_result_payload_data": { + "type": "object", + "properties": { + "redirect_to": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL to redirect to to get the data returned by the AddOn that was previously stored." + } + } + }, "api.v2010.account.recording.recording_transcription": { "type": "object", "properties": { @@ -5744,6 +5763,7 @@ }, "cidr_prefix_length": { "type": "integer", + "default": 0, "nullable": true, "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used." }, @@ -26616,14 +26636,14 @@ "readEmpty": { "value": { "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?Page=0&PageSize=50", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0", "next_page_uri": null, "page": 0, "page_size": 50, "previous_page_uri": null, "queue_members": [], "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0" } } } @@ -30846,7 +30866,7 @@ }, "examples": { "readEmpty": { - "value": true + "value": "true" } } }, @@ -30936,10 +30956,10 @@ "readEmpty": { "value": { "participants": [], - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=true&PageSize=50&Page=0", "next_page_uri": null, "previous_page_uri": null, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=true&PageSize=50&Page=0", "page": 0, "page_size": 50, "end": 0, @@ -31050,8 +31070,8 @@ "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "label": null, "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", - "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", "end_conference_on_exit": false, "muted": true, "hold": false, @@ -31986,7 +32006,7 @@ "value": { "end": 0, "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0", - "next_page_uri": null, + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=1&PageToken=PAQUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "page": 0, "page_size": 1, "previous_page_uri": null, @@ -32360,7 +32380,7 @@ }, "PartialResults": { "type": "boolean", - "description": "Indicates if partial results are going to be send to the customer" + "description": "Indicates if partial results are going to be sent to the customer" }, "LanguageCode": { "type": "string", @@ -32368,7 +32388,7 @@ }, "TranscriptionEngine": { "type": "string", - "description": "Definition of the transcription engine to be used, between those supported by Twilio" + "description": "Definition of the transcription engine to be used, among those supported by Twilio" }, "ProfanityFilter": { "type": "boolean", @@ -32376,7 +32396,7 @@ }, "SpeechModel": { "type": "string", - "description": "Recognition model used by the transcription engine, between those supported by the provider" + "description": "Recognition model used by the transcription engine, among those supported by the provider" }, "Hints": { "type": "string", @@ -32384,1111 +32404,319 @@ }, "EnableAutomaticPunctuation": { "type": "boolean", - "description": "The provider will adds punctuation to recognition result hypotheses" - }, - "Parameter1.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter1.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter2.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter2.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter3.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter3.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter4.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter4.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter5.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter5.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter6.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter6.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter7.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter7.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter8.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter8.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter9.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter9.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter10.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter10.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter11.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter11.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter12.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter12.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter13.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter13.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter14.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter14.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter15.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter15.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter16.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter16.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter17.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter17.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter18.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter18.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter19.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter19.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter20.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter20.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter21.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter21.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter22.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter22.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter23.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter23.Value": { - "type": "string", - "description": "Parameter value" + "description": "The provider will add punctuation to recognition result" + } + } + }, + "examples": { + "createNoArgs": { + "value": {} + }, + "createWithArgs": { + "value": { + "Name": "myName", + "Track": "inbound_track", + "StatusCallbackUrl": "http://statuscallback.com", + "StatusCallbackMethod": "PUT", + "InboundTrackLabel": "inbound_track_label", + "OutboundTrackLabel": "outbound_track_label", + "PartialResults": false, + "LanguageCode": "en-US", + "TranscriptionEngine": "google", + "ProfanityFilter": false, + "SpeechModel": "long", + "Hints": "this is a hint", + "EnableAutomaticPunctuation": true + } + } + } + } + } + } + } + }, + "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions/{Sid}.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "call_sid", + "name" + ], + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" + }, + "post": { + "description": "Stop a Transcription using either the SID of the Transcription resource or the `name` used when creating the resource", + "tags": [ + "Api20100401Transcription" + ], + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Transcription resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "CallSid", + "in": "path", + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the Transcription resource, or the `name` used when creating the resource", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.call.realtime_transcription" + }, + "examples": { + "updateBySid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } }, - "Parameter24.Name": { + "updateByName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myTranscription", + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } + } + }, + "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": "UpdateRealtimeTranscription", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateRealtimeTranscriptionRequest", + "properties": { + "Status": { "type": "string", - "description": "Parameter name" - }, - "Parameter24.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter25.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter25.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter26.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter26.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter27.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter27.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter28.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter28.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter29.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter29.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter30.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter30.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter31.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter31.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter32.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter32.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter33.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter33.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter34.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter34.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter35.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter35.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter36.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter36.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter37.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter37.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter38.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter38.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter39.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter39.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter40.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter40.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter41.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter41.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter42.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter42.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter43.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter43.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter44.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter44.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter45.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter45.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter46.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter46.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter47.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter47.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter48.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter48.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter49.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter49.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter50.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter50.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter51.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter51.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter52.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter52.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter53.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter53.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter54.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter54.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter55.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter55.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter56.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter56.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter57.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter57.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter58.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter58.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter59.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter59.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter60.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter60.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter61.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter61.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter62.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter62.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter63.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter63.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter64.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter64.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter65.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter65.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter66.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter66.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter67.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter67.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter68.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter68.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter69.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter69.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter70.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter70.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter71.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter71.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter72.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter72.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter73.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter73.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter74.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter74.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter75.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter75.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter76.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter76.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter77.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter77.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter78.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter78.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter79.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter79.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter80.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter80.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter81.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter81.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter82.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter82.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter83.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter83.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter84.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter84.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter85.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter85.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter86.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter86.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter87.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter87.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter88.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter88.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter89.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter89.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter90.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter90.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter91.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter91.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter92.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter92.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter93.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter93.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter94.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter94.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter95.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter95.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter96.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter96.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter97.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter97.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter98.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter98.Value": { - "type": "string", - "description": "Parameter value" - }, - "Parameter99.Name": { - "type": "string", - "description": "Parameter name" - }, - "Parameter99.Value": { - "type": "string", - "description": "Parameter value" - } - } - }, - "examples": { - "createNoArgs": { - "value": {} - }, - "createWithArgs": { - "value": { - "Name": "myName", - "Track": "inbound_track", - "StatusCallbackUrl": "http://statuscallback.com", - "StatusCallbackMethod": "PUT", - "InboundTrackLabel": "inbound_track_label", - "OutboundTrackLabel": "outbound_track_label", - "PartialResults": false, - "LanguageCode": "en-US", - "TranscriptionEngine": "google", - "ProfanityFilter": false, - "SpeechModel": "long", - "Hints": "this is a hint", - "EnableAutomaticPunctuation": true - } - } - } - } - } - } - } - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions/{Sid}.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "call_sid", - "name" - ], - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", - "pathType": "instance" - }, - "post": { - "description": "Stop a Transcription using either the SID of the Transcription resource or the `name` used when creating the resource", - "tags": [ - "Api20100401Transcription" - ], - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Transcription resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "CallSid", - "in": "path", - "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The SID of the Transcription resource, or the `name` used when creating the resource", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.realtime_transcription" - }, - "examples": { - "updateBySid": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "name": null, - "status": "stopped", - "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" - } - }, - "updateByName": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "name": "myTranscription", - "status": "stopped", - "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" - } - } - } - } - }, - "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": "UpdateRealtimeTranscription", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateRealtimeTranscriptionRequest", - "properties": { - "Status": { - "type": "string", - "$ref": "#/components/schemas/realtime_transcription_enum_update_status", - "description": "The status. Must have the value `stopped`" - } - }, - "required": [ - "Status" - ] - }, - "examples": { - "updateBySid": { - "value": { - "Status": "stopped" - } - }, - "updateByName": { - "value": { - "Status": "stopped" - } - } - } - } - } - } - } - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "Recordings of phone calls", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "call_sid", - "status", - "start_time", - "duration" - ], - "dependentProperties": { - "transcriptions": { - "mapping": { - "account_sid": "account_sid", - "recording_sid": "sid" - }, - "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{recording_sid}/Transcriptions.json" - }, - "add_on_results": { - "mapping": { - "account_sid": "account_sid", - "reference_sid": "sid" - }, - "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json" - } - }, - "parent": "/Accounts/{Sid}.json", - "pathType": "instance" - }, - "get": { - "description": "Fetch an instance of a recording", - "tags": [ - "Api20100401Recording" - ], - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "IncludeSoftDeleted", - "in": "query", - "description": "A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.", - "schema": { - "type": "boolean" - }, - "examples": { - "fetchIncludeSoftDeleted": { - "value": "true" - } - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "api_version": "2010-04-01", - "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "channels": 1, - "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", - "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", - "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", - "price": "-0.00250", - "price_unit": "USD", - "duration": "4", - "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source": "StartConferenceRecordingAPI", - "status": "completed", - "error_code": null, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", - "subresource_uris": { - "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", - "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" - }, - "encryption_details": { - "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", - "encryption_iv": "8I2hhNIYNTrwxfHk" - }, - "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } + "$ref": "#/components/schemas/realtime_transcription_enum_update_status", + "description": "The status. Must have the value `stopped`" + } + }, + "required": [ + "Status" + ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } + } + } + } + } + } + }, + "/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "Recordings of phone calls", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "call_sid", + "status", + "start_time", + "duration" + ], + "dependentProperties": { + "transcriptions": { + "mapping": { + "account_sid": "account_sid", + "recording_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{recording_sid}/Transcriptions.json" + }, + "add_on_results": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json" + } + }, + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" + }, + "get": { + "description": "Fetch an instance of a recording", + "tags": [ + "Api20100401Recording" + ], + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "IncludeSoftDeleted", + "in": "query", + "description": "A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.", + "schema": { + "type": "boolean" + }, + "examples": { + "fetchIncludeSoftDeleted": { + "value": "true" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.00250", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } }, "fetchIncludeSoftDeleted": { "value": { @@ -33838,126 +33066,548 @@ "readFull": { "value": { "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readIncludeSoftDeleted": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "OutboundAPI", + "status": "deleted", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "source": "OutboundAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&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": "ListRecording" + } + }, + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "The results of an Add-on API call", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "status", + "add_on_sid", + "date_created" + ], + "dependentProperties": { + "payloads": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "reference_sid", + "add_on_result_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" + } + }, + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" + }, + "get": { + "description": "Fetch an instance of an AddOnResult", + "tags": [ + "Api20100401AddOnResult" + ], + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ReferenceSid", + "in": "path", + "description": "The SID of the recording to which the result to fetch belongs.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + }, + "examples": { + "fetch": { + "value": { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } + } + } + } + } + }, + "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": "FetchRecordingAddOnResult" + }, + "delete": { + "description": "Delete a result and purge all associated Payloads", + "tags": [ + "Api20100401AddOnResult" + ], + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ReferenceSid", + "in": "path", + "description": "The SID of the recording to which the result to delete belongs.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteRecordingAddOnResult" + } + }, + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "The results of an Add-on API call", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "status", + "add_on_sid", + "date_created" + ], + "dependentProperties": { + "payloads": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "reference_sid", + "add_on_result_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" + } + }, + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of results belonging to the recording", + "tags": [ + "Api20100401AddOnResult" + ], + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to read.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ReferenceSid", + "in": "path", + "description": "The SID of the recording to which the result to read belongs.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "title": "ListRecordingAddOnResultResponse", + "type": "object", + "properties": { + "add_on_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + } + }, + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + } + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", "next_page_uri": null, "page": 0, - "page_size": 1, + "page_size": 50, "previous_page_uri": null, - "recordings": [ + "add_on_results": [ { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "api_version": "2010-04-01", - "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "channels": 1, - "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", - "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", - "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", - "price": "0.04", - "price_unit": "USD", - "duration": "4", - "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source": "StartConferenceRecordingAPI", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "completed", - "error_code": null, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", "subresource_uris": { - "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", - "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" - }, - "encryption_details": { - "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", - "encryption_iv": "8I2hhNIYNTrwxfHk" - }, - "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } } ], "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" } }, "readEmpty": { "value": { "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", - "next_page_uri": null, - "page": 0, - "page_size": 1, - "previous_page_uri": null, - "recordings": [], - "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" - } - }, - "readIncludeSoftDeleted": { - "value": { - "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", "next_page_uri": null, "page": 0, - "page_size": 2, + "page_size": 50, "previous_page_uri": null, - "recordings": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "api_version": "2010-04-01", - "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "channels": 2, - "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", - "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", - "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", - "price": "0.04", - "price_unit": "USD", - "duration": "6", - "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source": "OutboundAPI", - "status": "deleted", - "error_code": null, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", - "subresource_uris": { - "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", - "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" - }, - "encryption_details": { - "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", - "encryption_iv": "8I2hhNIYNTrwxfHk" - }, - "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "api_version": "2010-04-01", - "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", - "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", - "channels": 2, - "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", - "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", - "start_time": "Mon, 14 Feb 2022 22:23:00 +0000", - "price": "0.04", - "price_unit": "USD", - "duration": "6", - "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", - "source": "OutboundAPI", - "status": "completed", - "error_code": null, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json", - "subresource_uris": { - "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json", - "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json" - }, - "encryption_details": { - "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", - "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", - "encryption_iv": "8I2hhNIYNTrwxfHk" - }, - "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], + "add_on_results": [], "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" } } } @@ -34007,46 +33657,46 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording" + "operationId": "ListRecordingAddOnResult" } }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { "servers": [ { "url": "https://api.twilio.com" } ], - "description": "The results of an Add-on API call", + "description": "A single Add-on results' payload", "x-twilio": { "defaultOutputProperties": [ "sid", - "status", - "add_on_sid", - "date_created" + "label", + "content_type" ], "dependentProperties": { - "payloads": { + "data": { "mapping": { "account_sid": "account_sid", "reference_sid": "reference_sid", - "add_on_result_sid": "sid" + "add_on_result_sid": "add_on_result_sid", + "payload_sid": "sid" }, - "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" } }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", "pathType": "instance" }, "get": { - "description": "Fetch an instance of an AddOnResult", + "description": "Fetch an instance of a result payload", "tags": [ - "Api20100401AddOnResult" + "Api20100401Payload" ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch.", "schema": { "type": "string", "minLength": 34, @@ -34058,7 +33708,7 @@ { "name": "ReferenceSid", "in": "path", - "description": "The SID of the recording to which the result to fetch belongs.", + "description": "The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.", "schema": { "type": "string", "minLength": 34, @@ -34068,9 +33718,9 @@ "required": true }, { - "name": "Sid", + "name": "AddOnResultSid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.", + "description": "The SID of the AddOnResult to which the payload to fetch belongs.", "schema": { "type": "string", "minLength": 34, @@ -34078,6 +33728,18 @@ "pattern": "^XR[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XH[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -34085,22 +33747,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" }, "examples": { "fetch": { "value": { - "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "completed", "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", - "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", "subresource_uris": { - "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" } } } @@ -34151,18 +33814,18 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResult" + "operationId": "FetchRecordingAddOnResultPayload" }, "delete": { - "description": "Delete a result and purge all associated Payloads", + "description": "Delete a payload from the result along with all associated Data", "tags": [ - "Api20100401AddOnResult" + "Api20100401Payload" ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete.", "schema": { "type": "string", "minLength": 34, @@ -34174,7 +33837,7 @@ { "name": "ReferenceSid", "in": "path", - "description": "The SID of the recording to which the result to delete belongs.", + "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.", "schema": { "type": "string", "minLength": 34, @@ -34184,9 +33847,9 @@ "required": true }, { - "name": "Sid", + "name": "AddOnResultSid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.", + "description": "The SID of the AddOnResult to which the payloads to delete belongs.", "schema": { "type": "string", "minLength": 34, @@ -34194,6 +33857,18 @@ "pattern": "^XR[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XH[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -34206,46 +33881,46 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResult" + "operationId": "DeleteRecordingAddOnResultPayload" } }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { "servers": [ { "url": "https://api.twilio.com" } ], - "description": "The results of an Add-on API call", + "description": "A single Add-on results' payload", "x-twilio": { "defaultOutputProperties": [ "sid", - "status", - "add_on_sid", - "date_created" + "label", + "content_type" ], "dependentProperties": { - "payloads": { + "data": { "mapping": { "account_sid": "account_sid", "reference_sid": "reference_sid", - "add_on_result_sid": "sid" + "add_on_result_sid": "add_on_result_sid", + "payload_sid": "sid" }, - "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" } }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", "pathType": "list" }, "get": { - "description": "Retrieve a list of results belonging to the recording", + "description": "Retrieve a list of payloads belonging to the AddOnResult", "tags": [ - "Api20100401AddOnResult" + "Api20100401Payload" ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.", "schema": { "type": "string", "minLength": 34, @@ -34257,7 +33932,7 @@ { "name": "ReferenceSid", "in": "path", - "description": "The SID of the recording to which the result to read belongs.", + "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.", "schema": { "type": "string", "minLength": 34, @@ -34266,6 +33941,18 @@ }, "required": true }, + { + "name": "AddOnResultSid", + "in": "path", + "description": "The SID of the AddOnResult to which the payloads to read belongs.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XR[0-9a-fA-F]{32}$" + }, + "required": true + }, { "name": "PageSize", "in": "query", @@ -34299,13 +33986,13 @@ "content": { "application/json": { "schema": { - "title": "ListRecordingAddOnResultResponse", + "title": "ListRecordingAddOnResultPayloadResponse", "type": "object", "properties": { - "add_on_results": { + "payloads": { "type": "array", "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" } }, "end": { @@ -34344,42 +34031,43 @@ "readFull": { "value": { "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", "next_page_uri": null, "page": 0, "page_size": 50, "previous_page_uri": null, - "add_on_results": [ + "payloads": [ { - "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "completed", "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", - "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", "subresource_uris": { - "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" } } ], "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" } }, "readEmpty": { "value": { "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", "next_page_uri": null, "page": 0, "page_size": 50, "previous_page_uri": null, - "add_on_results": [], + "payloads": [], "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" } } } @@ -34429,40 +34117,27 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResult" + "operationId": "ListRecordingAddOnResultPayload" } }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{PayloadSid}/Data.json": { "servers": [ { "url": "https://api.twilio.com" } ], - "description": "A single Add-on results' payload", + "description": "The Payload Data subresource hosts the actual data returned by the Add-on", "x-twilio": { "defaultOutputProperties": [ - "sid", - "label", - "content_type" + "redirect_to" ], - "dependentProperties": { - "data": { - "mapping": { - "account_sid": "account_sid", - "reference_sid": "reference_sid", - "add_on_result_sid": "add_on_result_sid", - "payload_sid": "sid" - }, - "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" - } - }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json", "pathType": "instance" }, "get": { "description": "Fetch an instance of a result payload", "tags": [ - "Api20100401Payload" + "Api20100401Data" ], "parameters": [ { @@ -34502,7 +34177,7 @@ "required": true }, { - "name": "Sid", + "name": "PayloadSid", "in": "path", "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.", "schema": { @@ -34515,28 +34190,16 @@ } ], "responses": { - "200": { + "307": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload.recording_add_on_result_payload_data" }, "examples": { "fetch": { "value": { - "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "content_type": "application/json", - "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", - "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", - "subresource_uris": { - "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" - } + "redirect_to": "http://example.com" } } } @@ -34578,7 +34241,7 @@ } } }, - "description": "OK" + "description": "Temporary Redirect" } }, "security": [ @@ -34586,310 +34249,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResultPayload" - }, - "delete": { - "description": "Delete a payload from the result along with all associated Data", - "tags": [ - "Api20100401Payload" - ], - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ReferenceSid", - "in": "path", - "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "AddOnResultSid", - "in": "path", - "description": "The SID of the AddOnResult to which the payloads to delete belongs.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XH[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteRecordingAddOnResultPayload" - } - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "A single Add-on results' payload", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "label", - "content_type" - ], - "dependentProperties": { - "data": { - "mapping": { - "account_sid": "account_sid", - "reference_sid": "reference_sid", - "add_on_result_sid": "add_on_result_sid", - "payload_sid": "sid" - }, - "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" - } - }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", - "pathType": "list" - }, - "get": { - "description": "Retrieve a list of payloads belonging to the AddOnResult", - "tags": [ - "Api20100401Payload" - ], - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ReferenceSid", - "in": "path", - "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "AddOnResultSid", - "in": "path", - "description": "The SID of the AddOnResult to which the payloads to read belongs.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "title": "ListRecordingAddOnResultPayloadResponse", - "type": "object", - "properties": { - "payloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - } - }, - "examples": { - "readFull": { - "value": { - "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", - "next_page_uri": null, - "page": 0, - "page_size": 50, - "previous_page_uri": null, - "payloads": [ - { - "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "content_type": "application/json", - "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", - "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", - "subresource_uris": { - "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" - } - } - ], - "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" - } - }, - "readEmpty": { - "value": { - "end": 0, - "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", - "next_page_uri": null, - "page": 0, - "page_size": 50, - "previous_page_uri": null, - "payloads": [], - "start": 0, - "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?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": "ListRecordingAddOnResultPayload" + "operationId": "FetchRecordingAddOnResultPayloadData" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { @@ -43349,7 +42709,7 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { @@ -43417,7 +42777,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index 0eca5970..b38ca9ca 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -17,6 +17,7 @@ }, "size": { "type": "integer", + "default": 0, "nullable": true, "description": "The size of the day's data file in bytes" }, diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index 103802cf..b48b502b 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -98,11 +98,13 @@ }, "members_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Members in the Channel." }, "messages_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Messages in the Channel." }, @@ -455,6 +457,7 @@ }, "index": { "type": "integer", + "default": 0, "nullable": true, "description": "The index of the message within the [Channel](https://www.twilio.com/docs/chat/api/channels)." }, @@ -630,11 +633,13 @@ }, "typing_indicator_timeout": { "type": "integer", + "default": 0, "nullable": true, "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds." }, "consumption_report_interval": { "type": "integer", + "default": 0, "nullable": true, "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints." }, @@ -779,6 +784,7 @@ }, "joined_channels_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Channels this User is a Member of." }, diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index 587cb93d..99481aa9 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -203,11 +203,13 @@ }, "members_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Members in the Channel." }, "messages_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Messages that have been passed in the Channel." }, @@ -675,6 +677,7 @@ }, "index": { "type": "integer", + "default": 0, "nullable": true, "description": "The index of the message within the [Channel](https://www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message was received." }, @@ -872,11 +875,13 @@ }, "typing_indicator_timeout": { "type": "integer", + "default": 0, "nullable": true, "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds." }, "consumption_report_interval": { "type": "integer", + "default": 0, "nullable": true, "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints." }, @@ -909,11 +914,13 @@ }, "pre_webhook_retry_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried." }, "post_webhook_retry_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried." }, @@ -1031,6 +1038,7 @@ }, "joined_channels_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Channels the User is a Member of." }, diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index 9dc99ac4..14207a4e 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -98,11 +98,13 @@ }, "members_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Members in the Channel." }, "messages_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of Messages that have been passed in the Channel." }, diff --git a/spec/json/twilio_content_sdk.json b/spec/json/twilio_content_sdk.json index b70128bc..b7eb1980 100644 --- a/spec/json/twilio_content_sdk.json +++ b/spec/json/twilio_content_sdk.json @@ -140,6 +140,45 @@ "title" ] }, + "carouselActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/carouselAction" + } + }, + "carouselActionType": { + "type": "string", + "enum": [ + "URL", + "PHONE_NUMBER", + "QUICK_REPLY" + ] + }, + "carouselAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/carouselActionType" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, "authenticationActions": { "type": "array", "items": { @@ -198,6 +237,30 @@ } } }, + "carouselCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/carouselCard" + } + }, + "carouselCard": { + "type": "object", + "additionalProperties": false, + "properties": { + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "media": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/carouselActions" + } + } + }, "twilioText": { "type": "object", "description": "Type containing only plain text-based content", @@ -411,6 +474,24 @@ "body" ] }, + "twilioCarousel": { + "type": "object", + "description": "twilio/carousel templates allow you to send a single text message accompanied by a set of up to 10 carousel cards in a horizontally scrollable view", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "cards": { + "$ref": "#/components/schemas/carouselCards" + } + }, + "required": [ + "body", + "cards" + ] + }, "ContentApprovalRequest": { "type": "object", "description": "Content approval request body", @@ -485,6 +566,9 @@ "twilio/catalog": { "$ref": "#/components/schemas/twilioCatalog" }, + "twilio/carousel": { + "$ref": "#/components/schemas/twilioCarousel" + }, "whatsapp/card": { "$ref": "#/components/schemas/whatsappCard" }, @@ -832,7 +916,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateContentApprovalRequest" + "operationId": "CreateApprovalCreate" } }, "/v1/Content/{ContentSid}/ApprovalRequests": { @@ -906,7 +990,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApproval" + "operationId": "FetchApprovalFetch" } }, "/v1/Content/{Sid}": { diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index 9fbd8fa5..1198999b 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -366,6 +366,7 @@ }, "index": { "type": "integer", + "default": 0, "nullable": true, "description": "The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). Indices may skip numbers, but will always be in order of when the message was received." }, @@ -533,6 +534,7 @@ }, "error_code": { "type": "integer", + "default": 0, "nullable": true, "description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, " }, @@ -1411,6 +1413,7 @@ }, "index": { "type": "integer", + "default": 0, "nullable": true, "description": "The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)." }, @@ -1586,6 +1589,7 @@ }, "error_code": { "type": "integer", + "default": 0, "nullable": true, "description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, " }, diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index 899fec76..90cf2549 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -88,6 +88,7 @@ }, "latest_version": { "type": "integer", + "default": 0, "nullable": true, "description": "The latest version published of this schema." } @@ -103,6 +104,7 @@ }, "schema_version": { "type": "integer", + "default": 0, "nullable": true, "description": "The version of this schema." }, @@ -238,6 +240,7 @@ }, "schema_version": { "type": "integer", + "default": 0, "nullable": true, "description": "The schema version that the Subscription should use." }, diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 50ff75a9..13e78c8c 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -394,6 +394,7 @@ }, "phase": { "type": "integer", + "default": 0, "nullable": true, "description": "The phase this Flex Plugin would initialize at runtime." }, @@ -581,6 +582,13 @@ "task" ] }, + "flex_meeting_callback_events_enum_webhook_method": { + "type": "string", + "enum": [ + "POST", + "GET" + ] + }, "flex.v1.insights_assessments": { "type": "object", "properties": { @@ -811,6 +819,7 @@ }, "segment_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The count of segments for a conversation" }, @@ -945,6 +954,7 @@ }, "usage": { "type": "integer", + "default": 0, "nullable": true, "description": "Integer value that tells a particular question is used by how many questionnaires" }, @@ -12945,6 +12955,12 @@ { "name": "FlexV1FlexFlow" }, + { + "name": "FlexV1FlexMeetingCallbackEvents" + }, + { + "name": "FlexV1FlexTokenInfo" + }, { "name": "FlexV1FlexUser" }, diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index 3a6a0b2f..4c266be0 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -110,6 +110,19 @@ "nullable": true, "description": "Friendly name of the User." }, + "locale": { + "type": "string", + "nullable": true, + "description": "The locale preference of the user." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "The roles of the user." + }, "created_date": { "type": "string", "format": "date-time", @@ -124,6 +137,7 @@ }, "version": { "type": "integer", + "default": 0, "nullable": true, "description": "The current version of the user." }, @@ -242,8 +256,12 @@ "friendly_name": "friendly_name", "username": "username", "email": "sample@example.com", - "created_date": "2015-07-31T04:00:00Z", - "updated_date": "2015-07-31T04:00:00Z", + "locale": "en-US", + "roles": [ + "agent" + ], + "created_date": "2024-07-31T04:00:00Z", + "updated_date": "2024-07-31T04:00:00Z", "version": 1, "url": "https://flex-api.twilio.com/v2/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } @@ -296,6 +314,164 @@ } ], "operationId": "FetchFlexUser" + }, + "post": { + "description": "Update flex user for the given flex user sid", + "tags": [ + "FlexV2FlexUser" + ], + "parameters": [ + { + "name": "InstanceSid", + "in": "path", + "description": "The unique ID created by Twilio to identify a Flex instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "FlexUserSid", + "in": "path", + "description": "The unique id for the flex user.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FU[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v2.flex_user" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_user_sid": "FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_team_sid": "QOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "first_name": "firstname", + "last_name": "lastname", + "friendly_name": "friendly_name", + "username": "username", + "email": "sample@example.com", + "locale": "en-US", + "roles": [ + "agent" + ], + "created_date": "2024-07-31T04:00:00Z", + "updated_date": "2024-07-31T04:00:00Z", + "version": 1, + "url": "https://flex-api.twilio.com/v2/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "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": "UpdateFlexUser", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateFlexUserRequest", + "properties": { + "FirstName": { + "type": "string", + "description": "First name of the User." + }, + "LastName": { + "type": "string", + "description": "Last name of the User." + }, + "Email": { + "type": "string", + "description": "Email of the User." + }, + "FriendlyName": { + "type": "string", + "description": "Friendly name of the User." + }, + "UserSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^US[0-9a-fA-F]{32}$", + "description": "The unique SID identifier of the Twilio Unified User." + }, + "Locale": { + "type": "string", + "description": "The locale preference of the user." + } + } + }, + "examples": { + "update": { + "value": { + "Email": "sample@example.com" + } + } + } + } + } + } } }, "/v2/WebChats": { diff --git a/spec/json/twilio_iam_organizations.json b/spec/json/twilio_iam_organizations.json index 39727f67..a0db6743 100644 --- a/spec/json/twilio_iam_organizations.json +++ b/spec/json/twilio_iam_organizations.json @@ -2042,7 +2042,7 @@ } }, { - "name": "scope", + "name": "Scope", "in": "query", "required": false, "schema": { diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index 09efea50..0138282d 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -2231,18 +2231,10 @@ "type": "string" } }, - { - "name": "Branded", - "in": "query", - "description": "A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.", - "schema": { - "type": "boolean" - } - }, { "name": "VerifiedCaller", "in": "query", - "description": "A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.", + "description": "A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of 'true' or 'false'.", "schema": { "type": "boolean" }, @@ -2463,6 +2455,88 @@ } } }, + { + "name": "BrandedEnabled", + "in": "query", + "description": "A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of 'true' or 'false'", + "schema": { + "type": "boolean" + }, + "examples": { + "readWithCarrier": { + "value": true + } + } + }, + { + "name": "VoiceIntegrityEnabled", + "in": "query", + "description": "A boolean flag indicating whether or not the phone number had voice integrity enabled.One of 'true' or 'false'", + "schema": { + "type": "boolean" + }, + "examples": { + "readWithCarrier": { + "value": true + } + } + }, + { + "name": "BrandedBundleSid", + "in": "query", + "description": "A unique SID identifier of the Branded Call.", + "schema": { + "type": "string" + } + }, + { + "name": "VoiceIntegrityBundleSid", + "in": "query", + "description": "A unique SID identifier of the Voice Integrity Profile.", + "schema": { + "type": "string" + } + }, + { + "name": "VoiceIntegrityUseCase", + "in": "query", + "description": "A Voice Integrity Use Case . Is of type enum. One of 'abandoned_cart', 'appointment_reminders', 'appointment_scheduling', 'asset_management', 'automated_support', 'call_tracking', 'click_to_call', 'contact_tracing', 'contactless_delivery', 'customer_support', 'dating/social', 'delivery_notifications', 'distance_learning', 'emergency_notifications', 'employee_notifications', 'exam_proctoring', 'field_notifications', 'first_responder', 'fraud_alerts', 'group_messaging', 'identify_&_verification', 'intelligent_routing', 'lead_alerts', 'lead_distribution', 'lead_generation', 'lead_management', 'lead_nurturing', 'marketing_events', 'mass_alerts', 'meetings/collaboration', 'order_notifications', 'outbound_dialer', 'pharmacy', 'phone_system', 'purchase_confirmation', 'remote_appointments', 'rewards_program', 'self-service', 'service_alerts', 'shift_management', 'survey/research', 'telehealth', 'telemarketing', 'therapy_(individual+group)'.", + "schema": { + "type": "string" + } + }, + { + "name": "BusinessProfileIdentity", + "in": "query", + "description": "A Business Identity of the calls. Is of type enum. One of 'direct_customer', 'isv_reseller_or_partner'. ", + "schema": { + "type": "string" + } + }, + { + "name": "BusinessProfileIndustry", + "in": "query", + "description": "A Business Industry of the calls. Is of type enum. One of 'automotive', 'agriculture', 'banking', 'consumer', 'construction', 'education', 'engineering', 'energy', 'oil_and_gas', 'fast_moving_consumer_goods', 'financial', 'fintech', 'food_and_beverage', 'government', 'healthcare', 'hospitality', 'insurance', 'legal', 'manufacturing', 'media', 'online', 'professional_services', 'raw_materials', 'real_estate', 'religion', 'retail', 'jewelry', 'technology', 'telecommunications', 'transportation', 'travel', 'electronics', 'not_for_profit' ", + "schema": { + "type": "string" + } + }, + { + "name": "BusinessProfileBundleSid", + "in": "query", + "description": "A unique SID identifier of the Business Profile.", + "schema": { + "type": "string" + } + }, + { + "name": "BusinessProfileType", + "in": "query", + "description": "A Business Profile Type of the calls. Is of type enum. One of 'primary', 'secondary'.", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -2559,11 +2633,11 @@ "meta": { "page": 0, "page_size": 25, - "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0", + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&VoiceIntegrityEnabled=True&StartTime=4h&BrandedEnabled=True&PageSize=25&Page=0", "previous_page_url": null, "next_page_url": null, "key": "call_summaries", - "url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0" + "url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&VoiceIntegrityEnabled=True&StartTime=4h&BrandedEnabled=True&PageSize=25&Page=0" }, "call_summaries": [ { @@ -2651,6 +2725,23 @@ "trust": { "verified_caller": { "verified": true + }, + "branded": { + "enabled": true, + "display_name": "Owl bank", + "long_display_name": "Owl bank Ltd", + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167" + }, + "business_profile": { + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167", + "identity": "direct_customer", + "industry": "BANKING", + "type": "corporate" + }, + "voice_integrity": { + "enabled": true, + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167", + "use_case": "customer_support" } }, "annotation": null, @@ -2738,6 +2829,23 @@ "trust": { "verified_caller": { "verified": true + }, + "branded": { + "enabled": true, + "display_name": "Owl bank", + "long_display_name": "Owl bank Ltd", + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167" + }, + "business_profile": { + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167", + "identity": "direct_customer", + "industry": "BANKING", + "type": "corporate" + }, + "voice_integrity": { + "enabled": true, + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167", + "use_case": "customer_support" } }, "annotation": null, @@ -5673,7 +5781,28 @@ ], "attributes": {}, "properties": {}, - "trust": {}, + "trust": { + "verified_caller": { + "verified": true + }, + "branded": { + "enabled": true, + "display_name": "Owl bank", + "long_display_name": "Owl bank Ltd", + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167" + }, + "business_profile": { + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167", + "identity": "direct_customer", + "industry": "BANKING", + "type": "corporate" + }, + "voice_integrity": { + "enabled": true, + "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167", + "use_case": "customer_support" + } + }, "annotation": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index 160e7231..56675c57 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -48,6 +48,7 @@ }, "version": { "type": "integer", + "default": 0, "nullable": true, "description": "Numeric Custom Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Custom Operator." }, @@ -172,6 +173,7 @@ }, "version": { "type": "integer", + "default": 0, "nullable": true, "description": "Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator." }, @@ -521,6 +523,7 @@ }, "version": { "type": "integer", + "default": 0, "nullable": true, "description": "Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator." }, @@ -568,11 +571,13 @@ "properties": { "media_channel": { "type": "integer", + "default": 0, "nullable": true, "description": "The channel number." }, "sentence_index": { "type": "integer", + "default": 0, "nullable": true, "description": "The index of the sentence in the transcript." }, @@ -608,6 +613,12 @@ "confidence": { "type": "number", "nullable": true + }, + "words": { + "type": "array", + "items": {}, + "nullable": true, + "description": "Detailed information for each of the words of the given Sentence." } } }, @@ -704,6 +715,7 @@ }, "version": { "type": "integer", + "default": 0, "nullable": true, "description": "The version number of this Service." } @@ -788,6 +800,7 @@ }, "duration": { "type": "integer", + "default": 0, "nullable": true, "description": "The duration of this Transcript's source" }, @@ -1640,6 +1653,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -2482,6 +2510,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -2619,6 +2662,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -2899,12 +2957,9 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this Operator Type.", + "description": "Either a 34 character string that uniquely identifies this Operator Type or the unique name that references an Operator Type.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^EY[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -3387,7 +3442,8 @@ "transcript", "start_time", "end_time", - "confidence" + "confidence", + "words" ], "parent": "/Transcripts/{Sid}", "pathType": "list" @@ -3423,6 +3479,19 @@ } } }, + { + "name": "WordTimestamps", + "in": "query", + "description": "Returns word level timestamps information, if word_timestamps is enabled. The default is `false`.", + "schema": { + "type": "boolean" + }, + "examples": { + "readParams": { + "value": "True" + } + } + }, { "name": "PageSize", "in": "query", @@ -3510,7 +3579,19 @@ "end_time": null, "transcript": "test test", "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "confidence": null + "confidence": null, + "words": [ + { + "word": "test", + "start_time": null, + "end_time": null + }, + { + "word": "test", + "start_time": null, + "end_time": null + } + ] } ], "meta": { @@ -3534,15 +3615,27 @@ "end_time": null, "transcript": "test test", "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "confidence": null + "confidence": null, + "words": [ + { + "word": "test", + "start_time": null, + "end_time": null + }, + { + "word": "test", + "start_time": null, + "end_time": null + } + ] } ], "meta": { "key": "sentences", "page": 0, "page_size": 50, - "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0", - "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0", + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&WordTimestamps=True&PageSize=50&Page=0", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&WordTimestamps=True&PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null } @@ -3552,6 +3645,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -3660,6 +3768,21 @@ "type": "string" } }, + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -3904,6 +4027,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -3986,7 +4124,29 @@ ], "responses": { "204": { - "description": "The resource was deleted successfully." + "description": "The resource was deleted successfully.", + "headers": { + "ETag": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + } + } } }, "security": [ @@ -4051,6 +4211,21 @@ "type": "string" } }, + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -4159,6 +4334,21 @@ "type": "string" } }, + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -4368,6 +4558,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -4730,6 +4935,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -4867,6 +5087,21 @@ } }, "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { @@ -4933,7 +5168,24 @@ ], "responses": { "204": { - "description": "The resource was deleted successfully." + "description": "The resource was deleted successfully.", + "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + } + } } }, "security": [ diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index dd6d2790..0141052c 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -64,10 +64,12 @@ }, "members_count": { "type": "integer", + "default": 0, "nullable": true }, "messages_count": { "type": "integer", + "default": 0, "nullable": true }, "url": { @@ -341,6 +343,7 @@ }, "index": { "type": "integer", + "default": 0, "nullable": true }, "url": { @@ -483,10 +486,12 @@ }, "typing_indicator_timeout": { "type": "integer", + "default": 0, "nullable": true }, "consumption_report_interval": { "type": "integer", + "default": 0, "nullable": true }, "limits": { @@ -592,6 +597,7 @@ }, "joined_channels_count": { "type": "integer", + "default": 0, "nullable": true }, "links": { diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index 89cce186..268ef4e6 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -145,10 +145,12 @@ }, "members_count": { "type": "integer", + "default": 0, "nullable": true }, "messages_count": { "type": "integer", + "default": 0, "nullable": true }, "url": { @@ -514,6 +516,7 @@ }, "index": { "type": "integer", + "default": 0, "nullable": true }, "type": { @@ -670,10 +673,12 @@ }, "typing_indicator_timeout": { "type": "integer", + "default": 0, "nullable": true }, "consumption_report_interval": { "type": "integer", + "default": 0, "nullable": true }, "limits": { @@ -700,10 +705,12 @@ }, "pre_webhook_retry_count": { "type": "integer", + "default": 0, "nullable": true }, "post_webhook_retry_count": { "type": "integer", + "default": 0, "nullable": true }, "notifications": { @@ -787,6 +794,7 @@ }, "joined_channels_count": { "type": "integer", + "default": 0, "nullable": true }, "links": { diff --git a/spec/json/twilio_marketplace_v1.json b/spec/json/twilio_marketplace_v1.json index 086a3754..931503bd 100644 --- a/spec/json/twilio_marketplace_v1.json +++ b/spec/json/twilio_marketplace_v1.json @@ -235,7 +235,31 @@ }, "marketplace.v1.installed_add_on.installed_add_on_usage": { "type": "object", - "properties": {} + "properties": { + "billable_items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantity": { + "type": "number", + "description": "Any floating number greater than 0." + }, + "sid": { + "type": "string", + "description": "BillingSid to use for billing." + } + }, + "required": [ + "quantity", + "sid" + ] + } + } + }, + "required": [ + "billable_items" + ] }, "marketplace.v1.module_data_management": { "type": "object", @@ -243,29 +267,52 @@ "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "URL to query the subresource." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "ModuleSid that identifies this Listing." }, "description": { - "nullable": true + "nullable": true, + "description": "A JSON object describing the module and is displayed under the Description tab of the Module detail page. You can define the main body of the description, highlight key features or aspects of the module and if applicable, provide code samples for developers" }, "support": { - "nullable": true + "nullable": true, + "description": "A JSON object containing information on how customers can obtain support for the module. Use this parameter to provide details such as contact information and support description." }, "policies": { - "nullable": true + "nullable": true, + "description": "A JSON object describing the module's privacy and legal policies and is displayed under the Policies tab of the Module detail page. The maximum file size for Policies is 5MB" }, "module_info": { - "nullable": true + "nullable": true, + "description": "A JSON object containing essential attributes that define a module. This information is presented on the Module detail page in the Twilio Marketplace Catalog. You can pass the following attributes in the JSON object" }, "documentation": { - "nullable": true + "nullable": true, + "description": "A JSON object for providing comprehensive information, instructions, and resources related to the module" + }, + "configuration": { + "nullable": true, + "description": "A JSON object for providing listing specific configuration. Contains button setup, notification url, among others." + } + } + }, + "marketplace.v1.referral_conversion": { + "type": "object", + "properties": { + "converted_account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": false } } } @@ -2025,29 +2072,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "billable_items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quantity": { - "type": "number", - "description": "" - }, - "sid": { - "type": "string", - "description": "" - } - }, - "required": [ - "quantity", - "sid" - ] - } - } - } + "$ref": "#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_usage" }, "examples": { "multiple_sids": { @@ -2070,6 +2095,211 @@ } } }, + "/v1/ReferralConversion": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance" + }, + "post": { + "description": "", + "tags": [ + "MarketplaceReferralConversion" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace.v1.referral_conversion" + }, + "examples": { + "create": { + "value": { + "converted_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "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" + }, + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace.v1.referral_conversion" + }, + "examples": { + "create": { + "value": { + "converted_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "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": "ACCEPTED" + }, + "400": { + "content": { + "application/json": { + "schema": { + "type": "object", + "x-jvm-type": "com.twilio.rest.TwilioServiceErrorResponse" + } + } + }, + "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": "NOT_FOUND" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateReferralConversion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "referral_account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": false + } + } + }, + "examples": { + "create": { + "value": { + "referral_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } + } + }, "/v1/Listing/{Sid}": { "servers": [ { @@ -2150,6 +2380,18 @@ }, "documentation": { "body": "aBody" + }, + "configuration": { + "buttons": [ + { + "url": "https://example.com", + "label": "Configurable button text", + "help_text": "The button text, url, and help text are now configurable via self service" + } + ], + "notification_configuration": { + "callback_url": "https://example.com" + } } } } @@ -2230,6 +2472,10 @@ "Support": { "type": "string", "description": "" + }, + "Configuration": { + "type": "string", + "description": "" } } }, @@ -2240,7 +2486,8 @@ "Description": "test", "Documentation": "test", "Policies": "test", - "Support": "test" + "Support": "test", + "Configuration": "test" } } } @@ -2249,7 +2496,7 @@ } }, "get": { - "description": "", + "description": "This endpoint returns the data of a given Listing. To find a Listing's SID, use the [Available Add-ons resource](/docs/marketplace/api/available-add-ons) or view its Listing details page in the Console by visiting the [Catalog](https://console.twilio.com/us1/develop/add-ons/catalog) or the [My Listings tab](https://console.twilio.com/us1/develop/add-ons/publish/my-listings) and selecting the Listing.", "tags": [ "MarketplaceModuleDataManagement" ], @@ -2257,7 +2504,7 @@ { "name": "Sid", "in": "path", - "description": "", + "description": "The unique identifier of a Listing.", "schema": { "type": "string", "minLength": 34, @@ -2316,6 +2563,18 @@ }, "documentation": { "body": "aBody" + }, + "configuration": { + "buttons": [ + { + "url": "https://example.com", + "label": "Configurable button text", + "help_text": "The button text, url, and help text are now configurable via self service" + } + ], + "notification_configuration": { + "callback_url": "https://example.com" + } } } } @@ -2396,6 +2655,9 @@ }, { "name": "MarketplaceModuleDataManagement" + }, + { + "name": "MarketplaceReferralConversion" } ], "security": [ diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index bbe9225c..6cd5bcdd 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -843,6 +843,7 @@ }, "validity_period": { "type": "integer", + "default": 0, "nullable": true, "description": "How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`." }, @@ -3395,6 +3396,28 @@ "date_created": "2023-07-30T20:12:31Z", "date_updated": "2023-07-30T20:12:33Z", "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sender": "messenger:104794531907950", + "sender_type": "Messenger", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "sender": "rcs:ms_dev_ttatqler_agent", + "sender_type": "RCS", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" } ] } @@ -3447,6 +3470,160 @@ } ], "operationId": "ListChannelSender" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1ChannelSender" + ], + "parameters": [ + { + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.service.channel_sender" + }, + "examples": { + "createwhatsappsender": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sender": "whatsapp:+12487960483", + "sender_type": "WhatsApp", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createfbsender": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sender": "messenger:104794531907950", + "sender_type": "Messanger", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + }, + "creatercssender": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "sender": "rcs:ms_dev_test_agent", + "sender_type": "RCS", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } + } + } + } + }, + "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": "CreateChannelSender", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateChannelSenderRequest", + "properties": { + "Sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "description": "The SID of the Channel Sender being added to the Service." + } + }, + "required": [ + "Sid" + ] + }, + "examples": { + "createwhatsappsender": { + "value": { + "Sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createfbsender": { + "value": { + "Sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + }, + "creatercssender": { + "value": { + "Sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } + } + } + } + } + } } }, "/v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}": { @@ -3501,7 +3678,7 @@ "$ref": "#/components/schemas/messaging.v1.service.channel_sender" }, "examples": { - "fetch": { + "fetchwhatsappsender": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -3513,6 +3690,32 @@ "date_updated": "2023-07-30T20:12:33Z", "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } + }, + "fetchfbsender": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sender": "messenger:104794531907950", + "sender_type": "Messenger", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + }, + "fetchrcssender": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "sender": "rcs:ms_dev_test_agent", + "sender_type": "RCS", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } } } } @@ -3562,6 +3765,46 @@ } ], "operationId": "FetchChannelSender" + }, + "delete": { + "description": "", + "tags": [ + "MessagingV1ChannelSender" + ], + "parameters": [ + { + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the Channel Sender resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteChannelSender" } }, "/v1/Deactivations": { @@ -4509,6 +4752,10 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with." + }, + "CnpMigration": { + "type": "boolean", + "description": "Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call." } }, "required": [ @@ -4520,7 +4767,8 @@ "create": { "value": { "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CampaignId": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "CampaignId": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CnpMigration": false } } } diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index f1c8d5a7..4fda2ba4 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -270,6 +270,7 @@ }, "ttl": { "type": "integer", + "default": 0, "nullable": true, "description": "How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property." }, diff --git a/spec/json/twilio_numbers_v1.json b/spec/json/twilio_numbers_v1.json index 4ce1faea..c03ed13e 100644 --- a/spec/json/twilio_numbers_v1.json +++ b/spec/json/twilio_numbers_v1.json @@ -183,7 +183,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Account SID that the numbers will be added to after they are ported into Twilio." + "description": "Account Sid or subaccount where the phone number(s) will be Ported" }, "notification_emails": { "type": "array", @@ -191,23 +191,23 @@ "type": "string" }, "nullable": true, - "description": "List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails." + "description": "Additional emails to send a copy of the signed LOA to." }, "target_port_in_date": { "type": "string", "format": "date", "nullable": true, - "description": "Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation." + "description": "Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: \u20182011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. (This value is only available for custom porting customers.)" }, "target_port_in_time_range_start": { "type": "string", "nullable": true, - "description": "Minimum hour in the future needs to be established with the Ops team for validation." + "description": "The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: \u201810:15:00-08:00'. (This value is only available for custom porting customers.)" }, "target_port_in_time_range_end": { "type": "string", "nullable": true, - "description": "Maximum hour in the future needs to be established with the Ops team for validation." + "description": "The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: \u201810:15:00-08:00'. (This value is only available for custom porting customers.)" }, "port_in_request_status": { "type": "string", @@ -216,13 +216,12 @@ }, "losing_carrier_information": { "nullable": true, - "description": "The information for the losing carrier. " + "description": "Details regarding the customer\u2019s information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier\u2019s data as closely as possible to ensure the port is accepted." }, "phone_numbers": { "type": "array", "items": {}, - "nullable": true, - "description": "The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212)." + "nullable": true }, "documents": { "type": "array", @@ -230,7 +229,7 @@ "type": "string" }, "nullable": true, - "description": "The list of documents SID referencing a utility bills" + "description": "List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required." }, "date_created": { "type": "string", @@ -248,7 +247,7 @@ "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Port In request. This is a unique identifier of the port in request." + "description": "The unique identifier for the port in request that this phone number is associated with." }, "phone_number_sid": { "type": "string", @@ -256,12 +255,13 @@ "maxLength": 34, "pattern": "^PU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Port In request phone number. This is a unique identifier of the phone number." + "description": "The unique identifier for this phone number associated with this port in request." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "URL reference for this resource." }, "account_sid": { "type": "string", @@ -269,76 +269,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the account that the phone number belongs to." + "description": "Account Sid or subaccount where the phone number(s) will be Ported." }, "phone_number_type": { "type": "string", "nullable": true, - "description": "The type of the phone number." + "description": "The number type of the phone number. This can be: toll-free, local, mobile or unknown. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date when the phone number was created." + "description": "The timestamp for when this port in phone number was created." }, "country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The country of the phone number." + "description": "The ISO country code that this number is associated with. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated." }, "missing_required_fields": { "type": "boolean", "nullable": true, - "description": "The phone number is missing required fields." + "description": "Indicates if the phone number is missing required fields such as a PIN or account number. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated." }, "last_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The timestamp when the status was last updated." + "description": "Timestamp indicating when the Port In Phone Number resource was last modified." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number." + "description": "Phone number to be ported. This will be in the E164 Format." }, "portable": { "type": "boolean", "nullable": true, - "description": "The phone number is portable." + "description": "If the number is portable by Twilio or not. This field may be null if the number portability has not yet been evaluated. If a number is not portable reference the `not_portability_reason_code` and `not_portability_reason` fields for more details" }, "not_portability_reason": { "type": "string", "nullable": true, - "description": "The reason why the phone number is not portable." + "description": "The not portability reason code description. This field may be null if the number is portable or if the portability for a number has not yet been evaluated." }, "not_portability_reason_code": { "type": "integer", "nullable": true, - "description": "The code of the reason why the phone number is not portable." + "description": "The not portability reason code. This field may be null if the number is portable or if the portability for a number has not yet been evaluated." }, "port_in_phone_number_status": { "type": "string", "nullable": true, - "description": "The status of the phone number in the port in request." + "description": "The status of the port in phone number." }, "port_out_pin": { "type": "integer", "nullable": true, - "description": "The pin required for the losing carrier to port out the phone number." + "description": "The pin required by the losing carrier to do the port out." }, "rejection_reason": { "type": "string", "nullable": true, - "description": "The rejection reason returned by the vendor." + "description": "The description of the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier." }, "rejection_reason_code": { "type": "integer", "nullable": true, - "description": "The rejection reason code returned by the vendor." + "description": "The code for the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier." + }, + "port_date": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The timestamp the phone number will be ported. This will only be set once a port date has been confirmed. Not all carriers can guarantee a specific time on the port date. Twilio will try its best to get the port completed by this time on the port date. Please subscribe to webhooks for confirmation on when a port has actually been completed." } } }, @@ -349,7 +355,13 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212)." + "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "account_sid": { "type": "string", @@ -357,17 +369,17 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The target account sid to which the number will be ported" + "description": "Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio\u2019s inventory and belong to your account or sub account." }, "portable": { "type": "boolean", "nullable": true, - "description": "Boolean flag specifying if phone number is portable or not." + "description": "Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not." }, "pin_and_account_number_required": { "type": "boolean", "nullable": true, - "description": "Boolean flag specifying if PIN and account number is required for the phone number." + "description": "Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio." }, "not_portable_reason": { "type": "string", @@ -377,7 +389,7 @@ "not_portable_reason_code": { "type": "integer", "nullable": true, - "description": "The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`." + "description": "The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise." }, "number_type": { "type": "string", @@ -421,13 +433,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "Webhook URL to send a request when a port in request or port in phone number event happens" + "description": "The complete webhook url that will be called when a notification event for port in request or port in phone number happens" }, "port_out_target_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Webhook URL to send a request when a port out phone number event happens" + "description": "The complete webhook url that will be called when a notification event for a port out phone number happens." }, "notifications_of": { "type": "array", @@ -435,7 +447,7 @@ "type": "string" }, "nullable": true, - "description": "List of notification events to send a request to the webhook URL" + "description": "A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent." } } }, @@ -476,13 +488,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "Webhook URL to send a request when a port in request or port in phone number event happens" + "description": "The complete webhook url that will be called when a notification event for port in request or port in phone number happens" }, "port_out_target_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Webhook URL to send a request when a port out phone number event happens" + "description": "The complete webhook url that will be called when a notification event for a port out phone number happens." }, "notifications_of": { "type": "array", @@ -490,7 +502,7 @@ "type": "string" }, "nullable": true, - "description": "List of notification events to send a request to the webhook URL" + "description": "A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent." }, "port_in_target_date_created": { "type": "string", @@ -1156,7 +1168,8 @@ "not_portability_reason": "string", "not_portability_reason_code": 0, "port_in_phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "port_in_phone_number_status": "In Review" + "port_in_phone_number_status": "In Review", + "port_date": "2023-09-17T00:00:00Z" } ], "documents": [ @@ -1329,6 +1342,7 @@ "port_out_pin": 1234, "rejection_reason": null, "rejection_reason_code": null, + "port_date": "2024-05-17T00:00:00Z", "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumber/PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } @@ -1395,7 +1409,7 @@ "pathType": "instance" }, "get": { - "description": "Allows to check if a single phone number can be ported to Twilio or not.", + "description": "Check if a single phone number can be ported to Twilio", "tags": [ "NumbersV1PortingPortability" ], @@ -1403,17 +1417,23 @@ { "name": "PhoneNumber", "in": "path", - "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).", + "description": "Phone number to check portability in e164 format.", "schema": { "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "required": true }, { "name": "TargetAccountSid", "in": "query", - "description": "The SID of the account where the phone number(s) will be ported.", + "description": "Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.", "schema": { "type": "string", "minLength": 34, @@ -1510,7 +1530,7 @@ "pathType": "list" }, "post": { - "description": "Allows to create a new webhook configuration", + "description": "Create a Webhook Configuration", "tags": [ "NumbersV1PortingWebhookConfiguration" ], @@ -1714,7 +1734,7 @@ { "name": "WebhookType", "in": "path", - "description": "The of the webhook type of the configuration to be deleted", + "description": "The webhook type for the configuration to be delete. `PORT_IN`, `PORT_OUT`", "schema": { "type": "string", "$ref": "#/components/schemas/porting_webhook_configuration_delete_enum_webhook_type" @@ -1835,6 +1855,214 @@ } } } + }, + "get": { + "description": "Synchronous operation to retrieve configurations for the customer.", + "tags": [ + "NumbersV1SigningRequestConfiguration" + ], + "parameters": [ + { + "name": "Country", + "in": "query", + "description": "The country ISO code to apply this configuration, this is an optional field, Example: US, MX", + "schema": { + "type": "string" + }, + "examples": { + "readWithQueryParams": { + "value": "MX" + } + } + }, + { + "name": "Product", + "in": "query", + "description": "The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting", + "schema": { + "type": "string" + }, + "examples": { + "readWithQueryParams": { + "value": "Porting" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v1.signing_request_configuration" + } + }, + "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": "ListSigningRequestConfigurationResponse" + }, + "examples": { + "readWithoutQueryParams": { + "value": { + "configurations": [ + { + "logo_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Hosting CL", + "product": "Hosting", + "country": "CL", + "email_subject": "Email Subject", + "email_message": "Email Message", + "url_redirection": "https://www.twilio.com/redirect-url", + "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?PageSize=50&Page=0", + "next_page_url": null, + "key": "configurations" + } + } + }, + "readWithQueryParams": { + "value": { + "configurations": [ + { + "logo_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly name", + "product": "Porting", + "country": "MX", + "email_subject": "Email Subject", + "email_message": "Email Message", + "url_redirection": "https://my-redirection-url.com/redirect", + "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?Product=Porting&Country=MX&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?Product=Porting&Country=MX&PageSize=50&Page=0&PageToken=PTtestPageToken", + "next_page_url": null, + "key": "configurations" + } + } + } + } + } + }, + "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": "ListSigningRequestConfiguration" } } }, diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index b4948aed..08bb1a74 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -150,6 +150,7 @@ }, "total_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The total count of phone numbers in this Bulk hosting request." }, @@ -2180,6 +2181,10 @@ "NumberType": { "type": "string", "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll free`." + }, + "IsTest": { + "type": "boolean", + "description": "Indicates that Bundle is a Test Bundle and will be Auto-Rejected" } }, "required": [ diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index 415fdb0d..45854f8d 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,196 @@ "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." - }, - "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." + "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", + "verification_attempts": { + "type": "integer", + "default": 0, "nullable": true, - "description": "Contains an absolute URL for this Fleet resource." + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, - "unique_name": { + "email": { "type": "string", "nullable": true, - "description": "Contains a unique and addressable name of this Fleet, e.g. 'default', up to 128 characters long." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "friendly_name": { - "type": "string", + "cc_emails": { + "type": "array", + "items": { + "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", + "call_delay": { + "type": "integer", + "default": 0, "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": "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 +306,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 +314,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 +322,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 +338,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 +364,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 +390,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", @@ -529,6 +413,7 @@ }, "verification_attempts": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, @@ -549,7 +434,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 +442,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", @@ -578,13 +469,14 @@ }, "call_delay": { "type": "integer", + "default": 0, "nullable": true, "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, "verification_code": { "type": "string", "nullable": true, - "description": "The digits passed during the ownership verification call." + "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 +488,7 @@ } } }, - "dependent_hosted_number_order_enum_status": { + "hosted_number_order_enum_status": { "type": "string", "enum": [ "received", @@ -610,245 +502,35 @@ "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." + "description": "A short description of the Add-on's functionality." }, - "address_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." - }, - "signing_document_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign." - }, - "phone_number": { - "type": "string", - "format": "phone-number", - "nullable": true, - "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" - }, - "capabilities": { - "type": "object", - "format": "phone-number-capabilities", - "properties": { - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - }, - "fax": { - "type": "boolean" - } - }, - "nullable": true, - "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "A 64 character string that is a human-readable text that describes this resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - "status": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status", - "nullable": true, - "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses." - }, - "failure_reason": { - "type": "string", - "nullable": true, - "description": "A message that explains why a hosted_number_order went to status \"action-required\"" - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "verification_attempts": { - "type": "integer", - "nullable": true, - "description": "The number of attempts made to verify ownership of the phone number that is being hosted." - }, - "email": { - "type": "string", - "nullable": true, - "description": "Email of the owner of this phone number that is being hosted.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - "cc_emails": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of this HostedNumberOrder." - }, - "verification_type": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "nullable": true, - "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." - }, - "verification_document_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." - }, - "extension": { - "type": "string", - "nullable": true, - "description": "A numerical extension to be used when making the ownership verification call." - }, - "call_delay": { - "type": "integer", - "nullable": true, - "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." - }, - "verification_code": { - "type": "string", - "nullable": true, - "description": "A verification code provided in the response for a user to enter when they pick up the phone call." - }, - "verification_call_sids": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." - } - } - }, - "hosted_number_order_enum_status": { - "type": "string", - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ] - }, - "hosted_number_order_enum_verification_type": { - "type": "string", - "enum": [ - "phone-call", - "phone-bill" - ] - }, - "preview.marketplace.available_add_on": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the AvailableAddOn resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." - }, - "description": { - "type": "string", - "nullable": true, - "description": "A short description of the Add-on's functionality." - }, - "pricing_type": { + "pricing_type": { "type": "string", "nullable": true, "description": "How customers are charged for using this Add-on." @@ -1024,49 +706,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 +763,99 @@ "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, + "nullable": true + }, + "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 +865,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 +963,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", - "nullable": true - }, - "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." + "description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." }, - "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": { + "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 +1361,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", - "nullable": true - }, - "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 +1395,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 +1564,318 @@ "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, + "nullable": true + }, + "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": { + "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 +1898,7 @@ }, "openapi": "3.0.1", "paths": { - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "/HostedNumbers/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -1901,33 +1907,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 +2035,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 +2103,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 +2266,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 +2402,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 +2482,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 +2702,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 +2741,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 +2853,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesCertificate" + "operationId": "ListHostedNumbersDependentHostedNumberOrder" } }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { + "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -2511,33 +2865,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 +2891,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 +2977,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 +3008,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 +3034,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 +3120,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 +3199,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "/HostedNumbers/HostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" @@ -2789,139 +3208,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 +3333,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 +3372,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 +3471,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 +3629,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -3332,40 +3637,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 +3783,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "/marketplace/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -3383,47 +3792,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 +3891,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -3473,78 +3899,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 +3962,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 +4001,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 +4101,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 +4153,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 +4213,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 +4280,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 +4389,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 +4421,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 +4515,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 +4562,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 +4602,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 +4641,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 +4737,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesFleet" + "operationId": "ListMarketplaceInstalledAddOn" } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "/marketplace/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4321,33 +4749,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 +4820,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 +4889,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 +4915,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 +4984,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 +5014,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4601,44 +5023,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 +5215,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -4688,64 +5223,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 +5318,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 +5357,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 +5445,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesKey" + "operationId": "ListMarketplaceInstalledAddOnExtension" } }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "/wireless/Commands/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4923,125 +5457,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 +5483,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 +5548,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 +5560,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 +5667,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 +5706,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 +5798,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 +5875,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 +5935,7 @@ } } }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "/wireless/RatePlans": { "servers": [ { "url": "https://preview.twilio.com" @@ -5580,109 +5944,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 +5987,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 +6026,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 +6201,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -5869,10 +6209,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 +6299,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 +6319,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 +6391,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 +6414,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 +6486,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 +6554,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 +6585,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 +6664,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 +6758,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -6653,63 +6766,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 +6820,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 +6908,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 +7022,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 +7061,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 +7292,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 +7304,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 +7340,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 +7403,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 +7541,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 +7584,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 +7671,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 +7713,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 +7773,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 +7812,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 +7902,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOn" + "operationId": "ListDeployedDevicesCertificate" } }, - "/marketplace/InstalledAddOns/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -7765,68 +7914,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 +7950,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 +8012,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 +8052,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 +8087,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 +8149,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 +8270,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -8239,63 +8278,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 +8361,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 +8400,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 +8489,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 +8501,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 +8534,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 +8600,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 +8637,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 +8669,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 +8735,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 +8777,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Documents": { + "/DeployedDevices/Fleets/{FleetSid}/Devices": { "servers": [ { "url": "https://preview.twilio.com" @@ -8783,33 +8786,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 +8810,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 +8876,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 +8912,9 @@ "examples": { "create": { "value": { - "Data": "{}", - "UniqueName": "unique_name" + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Identity": "identity" } } } @@ -8921,22 +8923,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 +8983,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 +9022,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 +9115,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 +9127,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 +9295,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 +9363,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 +9504,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -9381,87 +9512,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 +9578,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 +9617,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 +9712,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission" + "operationId": "ListDeployedDevicesFleet" } }, - "/Sync/Services/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -9637,43 +9724,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 +9760,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 +9823,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 +9863,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 +9898,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 +9961,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 +9995,7 @@ } } }, - "/Sync/Services": { + "/DeployedDevices/Fleets/{FleetSid}/Keys": { "servers": [ { "url": "https://preview.twilio.com" @@ -9926,57 +10004,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 +10091,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 +10125,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 +10185,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 +10224,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 +10314,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 +10327,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 +10371,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 +10443,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList" + "operationId": "FetchSyncDocument" }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewSyncDocument" ], "parameters": [ { @@ -10413,10 +10483,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 +10637,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 +10672,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 +10744,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 +10776,7 @@ "get": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewSyncDocument" ], "parameters": [ { @@ -10614,10 +10826,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 +10865,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 +10959,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 +10971,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 +10994,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 +11017,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 +11079,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 +11149,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 +11168,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 +11226,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -11195,37 +11234,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 +11307,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 +11350,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 +11389,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 +11478,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 +11490,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 +11529,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 +11536,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 +11604,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 +11653,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 +11871,7 @@ } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -11739,87 +11879,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 +11960,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 +11999,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 +12094,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 +12110,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 +12159,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 +12169,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 +12226,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMap" + "operationId": "FetchSyncSyncList" }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewSyncSyncList" ], "parameters": [ { @@ -12155,10 +12266,10 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMap" + "operationId": "DeleteSyncSyncList" } }, - "/Sync/Services/{ServiceSid}/Maps": { + "/Sync/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://preview.twilio.com" @@ -12171,26 +12282,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 +12322,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 +12332,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 +12389,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 +12417,7 @@ "get": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewSyncSyncList" ], "parameters": [ { @@ -12356,10 +12467,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 +12506,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 +12600,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 +12612,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 +12635,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12533,11 +12644,11 @@ "required": true }, { - "name": "Key", + "name": "Index", "in": "path", "description": "", "schema": { - "type": "string" + "type": "integer" }, "required": true } @@ -12547,7 +12658,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 +12668,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 +12727,12 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem" + "operationId": "FetchSyncSyncListItem" }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12637,7 +12748,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12646,11 +12757,11 @@ "required": true }, { - "name": "Key", + "name": "Index", "in": "path", "description": "", "schema": { - "type": "string" + "type": "integer" }, "required": true }, @@ -12673,12 +12784,12 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapItem" + "operationId": "DeleteSyncSyncListItem" }, "post": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12694,7 +12805,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12703,11 +12814,11 @@ "required": true }, { - "name": "Key", + "name": "Index", "in": "path", "description": "", "schema": { - "type": "string" + "type": "integer" }, "required": true }, @@ -12725,7 +12836,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 +12846,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 +12905,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 +12933,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" @@ -12831,14 +12942,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 +12965,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -12868,7 +12979,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 +12989,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 +13048,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 +13078,7 @@ "get": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewSyncSyncListItem" ], "parameters": [ { @@ -12989,7 +13094,7 @@ "required": true }, { - "name": "MapSid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -13003,7 +13108,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 +13141,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 +13190,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 +13226,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 +13252,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 +13317,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 +13329,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 +13352,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 +13375,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 +13437,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 +13458,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 +13486,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 +13507,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 +13530,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 +13592,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 +13633,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -13537,14 +13642,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 +13665,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 +13711,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 +13747,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 +13770,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 +13836,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapPermission" + "operationId": "ListSyncSyncListPermission" } }, - "/wireless/Commands/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -13743,23 +13848,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 +13901,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 +13968,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 +14020,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 +14209,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 +14248,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 +14342,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 +14354,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 +14400,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 +14469,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 +14639,7 @@ } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -14495,76 +14647,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 +14675,7 @@ } } }, - "/wireless/RatePlans/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" @@ -14582,16 +14684,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 +14717,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 +14782,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 +14933,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 +15065,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 +15077,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 +15123,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 +15185,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 +15278,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 +15340,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 +15381,7 @@ } } }, - "/wireless/Sims": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -15192,86 +15389,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 +15456,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 +15495,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 +15584,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 +15595,13 @@ ], "tags": [ { - "name": "PreviewDeployedDevicesCertificate" - }, - { - "name": "PreviewDeployedDevicesDeployment" - }, - { - "name": "PreviewDeployedDevicesDevice" + "name": "PreviewHostedNumbersAuthorizationDocument" }, { - "name": "PreviewDeployedDevicesFleet" + "name": "PreviewHostedNumbersDependentHostedNumberOrder" }, { - "name": "PreviewDeployedDevicesKey" + "name": "PreviewHostedNumbersHostedNumberOrder" } ], "security": [ diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 33ca738a..4912b211 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -543,6 +543,7 @@ }, "in_use": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of open session assigned to the number. See the [How many Phone Numbers do I need?](https://www.twilio.com/docs/proxy/phone-numbers-needed) guide for more information." } @@ -588,6 +589,7 @@ }, "default_ttl": { "type": "integer", + "default": 0, "nullable": true, "description": "The default `ttl` value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value." }, @@ -726,6 +728,7 @@ }, "ttl": { "type": "integer", + "default": 0, "nullable": true, "description": "The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction." }, diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 2370b74c..4872914a 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -440,6 +440,7 @@ }, "version": { "type": "integer", + "default": 0, "nullable": true, "description": "The latest version number of the Flow's definition." }, diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index d1ef5ba5..1c3705ba 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -314,6 +314,7 @@ }, "revision": { "type": "integer", + "default": 0, "nullable": true, "description": "The latest revision number of the Flow's definition." }, @@ -413,6 +414,7 @@ }, "revision": { "type": "integer", + "default": 0, "nullable": true, "description": "The latest revision number of the Flow's definition." }, diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index fa90b247..dd1cded1 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -228,6 +228,7 @@ }, "data_limit": { "type": "integer", + "default": 0, "nullable": true, "description": "The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 250MB." }, @@ -341,6 +342,7 @@ }, "device_port": { "type": "integer", + "default": 0, "nullable": true, "description": "For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message." }, diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 0af27203..c3a9de95 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -245,6 +245,7 @@ }, "reachability_debouncing_window": { "type": "integer", + "default": 0, "nullable": true, "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before `webhook_url` is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring." }, @@ -370,6 +371,7 @@ "properties": { "index": { "type": "integer", + "default": 0, "nullable": true, "description": "The automatically generated index of the List Item. The `index` values of the List Items in a Sync List can have gaps in their sequence." }, diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index c75ae125..79814486 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -191,6 +191,7 @@ }, "age": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of seconds since the Task was created." }, @@ -236,6 +237,7 @@ }, "priority": { "type": "integer", + "default": 0, "nullable": true, "description": "The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values." }, @@ -280,6 +282,7 @@ }, "timeout": { "type": "integer", + "default": 0, "nullable": true, "description": "The amount of time in seconds that the Task can live before being assigned." }, @@ -325,7 +328,7 @@ "ignore_capacity": { "type": "boolean", "nullable": true, - "description": "A boolean indicating if a new task should respect a worker's capacity during assignment" + "description": "A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker without respecting their capacity and availability. Any other value will enforce the Worker's capacity and availability. The default value of `IgnoreCapacity` is `true` when the `RoutingTarget` is set to a Worker SID. " }, "routing_target": { "type": "string", @@ -462,6 +465,7 @@ }, "max_reserved_workers": { "type": "integer", + "default": 0, "nullable": true, "description": "The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1." }, @@ -553,6 +557,7 @@ }, "task_queue_response_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of TaskQueue statistics received in task_queue_data." }, @@ -577,6 +582,7 @@ }, "avg_task_acceptance_time": { "type": "integer", + "default": 0, "nullable": true, "description": "The average time in seconds between Task creation and acceptance." }, @@ -594,31 +600,37 @@ }, "reservations_created": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations created for Tasks in the TaskQueue." }, "reservations_accepted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations accepted for Tasks in the TaskQueue." }, "reservations_rejected": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations rejected for Tasks in the TaskQueue." }, "reservations_timed_out": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that timed out for Tasks in the TaskQueue." }, "reservations_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations canceled for Tasks in the TaskQueue." }, "reservations_rescinded": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations rescinded." }, @@ -648,26 +660,31 @@ }, "tasks_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks canceled in the TaskQueue." }, "tasks_completed": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks completed in the TaskQueue." }, "tasks_deleted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks deleted in the TaskQueue." }, "tasks_entered": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks entered into the TaskQueue." }, "tasks_moved": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were moved from one queue to another." }, @@ -706,6 +723,7 @@ }, "longest_task_waiting_age": { "type": "integer", + "default": 0, "nullable": true, "description": "The age of the longest waiting Task." }, @@ -719,6 +737,7 @@ }, "longest_relative_task_age_in_queue": { "type": "integer", + "default": 0, "nullable": true, "description": "The relative age in the TaskQueue for the longest waiting Task. Calculation is based on the time when the Task entered the TaskQueue." }, @@ -748,16 +767,19 @@ }, "total_available_workers": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Workers available for Tasks in the TaskQueue." }, "total_eligible_workers": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state." }, "total_tasks": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks." }, @@ -1091,6 +1113,7 @@ }, "assigned_tasks": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks assigned to Worker for the TaskChannel type." }, @@ -1101,11 +1124,13 @@ }, "available_capacity_percentage": { "type": "integer", + "default": 0, "nullable": true, "description": "The current percentage of capacity the TaskChannel has available. Can be a number between `0` and `100`. A value of `0` indicates that TaskChannel has no capacity available and a value of `100` means the Worker is available to receive any Tasks of this TaskChannel type." }, "configured_capacity": { "type": "integer", + "default": 0, "nullable": true, "description": "The current configured capacity for the WorkerChannel. TaskRouter will not create any reservations after the assigned Tasks for the Worker reaches the value." }, @@ -1385,31 +1410,37 @@ }, "reservations_created": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were created." }, "reservations_accepted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were accepted." }, "reservations_rejected": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were rejected." }, "reservations_timed_out": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were timed out." }, "reservations_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were canceled." }, "reservations_rescinded": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were rescinded." }, @@ -1448,6 +1479,7 @@ }, "total_workers": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Workers." }, @@ -1533,6 +1565,7 @@ }, "task_reservation_timeout": { "type": "integer", + "default": 0, "nullable": true, "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`." }, @@ -1571,6 +1604,7 @@ }, "avg_task_acceptance_time": { "type": "integer", + "default": 0, "nullable": true, "description": "The average time in seconds between Task creation and acceptance." }, @@ -1588,31 +1622,37 @@ }, "reservations_created": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were created for Workers." }, "reservations_accepted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations accepted by Workers." }, "reservations_rejected": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were rejected." }, "reservations_timed_out": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were timed out." }, "reservations_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were canceled." }, "reservations_rescinded": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were rescinded." }, @@ -1630,31 +1670,37 @@ }, "tasks_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were canceled." }, "tasks_completed": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were completed." }, "tasks_entered": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that entered the Workflow." }, "tasks_deleted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were deleted." }, "tasks_moved": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were moved from one queue to another." }, "tasks_timed_out_in_workflow": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were timed out of their Workflows (and deleted)." }, @@ -1695,6 +1741,7 @@ }, "longest_task_waiting_age": { "type": "integer", + "default": 0, "nullable": true, "description": "The age of the longest waiting Task." }, @@ -1716,6 +1763,7 @@ }, "total_tasks": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks." }, @@ -1910,6 +1958,7 @@ }, "avg_task_acceptance_time": { "type": "integer", + "default": 0, "nullable": true, "description": "The average time in seconds between Task creation and acceptance." }, @@ -1927,31 +1976,37 @@ }, "reservations_created": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were created for Workers." }, "reservations_accepted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations accepted by Workers." }, "reservations_rejected": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were rejected." }, "reservations_timed_out": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were timed out." }, "reservations_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were canceled." }, "reservations_rescinded": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Reservations that were rescinded." }, @@ -1969,31 +2024,37 @@ }, "tasks_canceled": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were canceled." }, "tasks_completed": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were completed." }, "tasks_created": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks created." }, "tasks_deleted": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were deleted." }, "tasks_moved": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were moved from one queue to another." }, "tasks_timed_out_in_workflow": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks that were timed out of their Workflows (and deleted)." }, @@ -2032,6 +2093,7 @@ }, "longest_task_waiting_age": { "type": "integer", + "default": 0, "nullable": true, "description": "The age of the longest waiting Task." }, @@ -2053,11 +2115,13 @@ }, "total_tasks": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Tasks." }, "total_workers": { "type": "integer", + "default": 0, "nullable": true, "description": "The total number of Workers in the Workspace." }, @@ -4449,7 +4513,7 @@ }, "IgnoreCapacity": { "type": "string", - "description": "A boolean indicating if a new task should respect a worker's capacity during assignment" + "description": "A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker without respecting their capacity and availability. Any other value will enforce the Worker's capacity and availability. The default value of `IgnoreCapacity` is `true` when the `RoutingTarget` is set to a Worker SID. " }, "TaskQueueSid": { "type": "string", diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index a0d15c80..44d976b6 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -140,6 +140,7 @@ }, "weight": { "type": "integer", + "default": 0, "nullable": true, "description": "The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority." }, @@ -167,6 +168,7 @@ }, "priority": { "type": "integer", + "default": 0, "nullable": true, "description": "The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI." }, diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index f8e2ad5c..e450a090 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -993,6 +993,14 @@ "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" } + }, + "createWithThemeSetId": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" + } } } } @@ -1059,6 +1067,10 @@ "NotificationEmail": { "type": "string", "description": "The email address that approval status updates will be sent to. If not specified, the email address associated with your primary customer profile will be used." + }, + "ThemeSetId": { + "type": "string", + "description": "Theme id for styling the inquiry form." } }, "required": [ @@ -1076,6 +1088,13 @@ "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "NotificationEmail": "pfarnsworth@twilio.com" } + }, + "createWithThemeSetId": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "NotificationEmail": "pfarnsworth@twilio.com", + "ThemeSetId": "th_xxxxx" + } } } } @@ -1131,6 +1150,14 @@ "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" } + }, + "updateWithThemeSetId": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" + } } } } @@ -1193,6 +1220,10 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile." + }, + "ThemeSetId": { + "type": "string", + "description": "Theme id for styling the inquiry form." } }, "required": [ @@ -1204,6 +1235,12 @@ "value": { "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } + }, + "updateWithThemeSetId": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ThemeSetId": "th_xxxxx" + } } } } diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 206025be..92c38fe3 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -69,6 +69,7 @@ }, "ttl": { "type": "integer", + "default": 0, "nullable": true, "description": "How long, in seconds, the access token is valid. Max: 5 minutes" }, @@ -123,11 +124,13 @@ }, "max": { "type": "integer", + "default": 0, "nullable": true, "description": "Maximum number of requests permitted in during the interval." }, "interval": { "type": "integer", + "default": 0, "nullable": true, "description": "Number of seconds that the rate limit will be enforced over." }, @@ -788,6 +791,7 @@ }, "ttl": { "type": "integer", + "default": 0, "nullable": true, "description": "How long, in seconds, the notification is valid. Max: 5 minutes" }, @@ -918,6 +922,7 @@ }, "code_length": { "type": "integer", + "default": 0, "nullable": true, "description": "The length of the verification code to generate." }, @@ -954,7 +959,7 @@ "custom_code_enabled": { "type": "boolean", "nullable": true, - "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers." + "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one." }, "push": { "nullable": true, @@ -1273,16 +1278,19 @@ "properties": { "total_attempts": { "type": "integer", + "default": 0, "nullable": true, "description": "Total of attempts made according to the provided filters" }, "total_converted": { "type": "integer", + "default": 0, "nullable": true, "description": "Total of attempts made that were confirmed by the end user, according to the provided filters." }, "total_unconverted": { "type": "integer", + "default": 0, "nullable": true, "description": "Total of attempts made that were not confirmed by the end user, according to the provided filters." }, @@ -6980,7 +6988,7 @@ }, "CustomCodeEnabled": { "type": "boolean", - "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers." + "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one." }, "Push.IncludeDate": { "type": "boolean", @@ -7633,7 +7641,7 @@ }, "CustomCodeEnabled": { "type": "boolean", - "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers." + "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one." }, "Push.IncludeDate": { "type": "boolean", diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 7ebdf31f..677446ec 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -114,6 +114,7 @@ }, "bitrate": { "type": "integer", + "default": 0, "nullable": true, "description": "The average bit rate of the composition's media." }, @@ -125,6 +126,7 @@ }, "duration": { "type": "integer", + "default": 0, "nullable": true, "description": "The duration of the composition's media file in seconds." }, @@ -659,11 +661,13 @@ }, "max_participants": { "type": "integer", + "default": 0, "nullable": true, "description": "The maximum number of concurrent Participants allowed in the room. " }, "max_participant_duration": { "type": "integer", + "default": 0, "nullable": true, "description": "The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours)." }, @@ -698,11 +702,13 @@ }, "empty_room_timeout": { "type": "integer", + "default": 0, "nullable": true, "description": "Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed." }, "unused_room_timeout": { "type": "integer", + "default": 0, "nullable": true, "description": "Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed." }, diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 6aeedd7a..47586d9c 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -259,11 +259,13 @@ }, "priority": { "type": "integer", + "default": 0, "nullable": true, "description": "The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target." }, "weight": { "type": "integer", + "default": 0, "nullable": true, "description": "The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority." }, @@ -413,6 +415,7 @@ "properties": { "update_count": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of countries updated" }, @@ -486,6 +489,7 @@ }, "cidr_prefix_length": { "type": "integer", + "default": 0, "nullable": true, "description": "An integer representing the length of the [CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32." }, diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index 6ae70aec..3fce693c 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -215,11 +215,13 @@ }, "packets_uploaded": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of packets uploaded by the device between the `start` time and when the Data Session was last updated." }, "packets_downloaded": { "type": "integer", + "default": 0, "nullable": true, "description": "The number of packets downloaded by the device between the `start` time and when the Data Session was last updated." }, @@ -289,6 +291,7 @@ }, "data_limit": { "type": "integer", + "default": 0, "nullable": true, "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB." }, @@ -309,6 +312,7 @@ }, "national_roaming_data_limit": { "type": "integer", + "default": 0, "nullable": true, "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB." }, @@ -322,6 +326,7 @@ }, "international_roaming_data_limit": { "type": "integer", + "default": 0, "nullable": true, "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB." }, diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index e2ffe865..0574a946 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -1577,6 +1577,7 @@ components: out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).' channels: type: integer + default: 0 nullable: true description: 'The number of channels in the final recording file. Can be: `1`, or `2`. Separating a two leg call into two separate channels of the @@ -1795,6 +1796,7 @@ components: out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).' channels: type: integer + default: 0 nullable: true description: 'The number of channels in the final recording file. Can be: `1`, or `2`. Separating a two leg call into two separate channels of the @@ -3457,6 +3459,7 @@ components: description: The date that the member was enqueued, given in RFC 2822 format. position: type: integer + default: 0 nullable: true description: This member's current position in the queue. uri: @@ -3465,6 +3468,7 @@ components: description: The URI of the resource, relative to `https://api.twilio.com`. wait_time: type: integer + default: 0 nullable: true description: The number of seconds the member has been in the queue. queue_sid: @@ -3546,7 +3550,9 @@ components: nullable: true description: The description of the `error_code` if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is - `null`. + `null`. The value returned in this field for a specific error cause is + subject to change as Twilio improves errors. Users should not use the + `error_code` and `error_message` fields programmatically. uri: type: string nullable: true @@ -3607,7 +3613,9 @@ components: nullable: true description: The [error code](https://www.twilio.com/docs/api/errors) returned if the Message `status` is `failed` or `undelivered`. If no error was - encountered, the value is `null`. + encountered, the value is `null`. The value returned in this field for + a specific error cause is subject to change as Twilio improves errors. + Users should not use the `error_code` and `error_message` fields programmatically. price_unit: type: string format: currency @@ -4251,6 +4259,7 @@ components: specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. current_size: type: integer + default: 0 nullable: true description: The number of calls currently in the queue. friendly_name: @@ -4271,6 +4280,7 @@ components: that created this Queue resource. average_wait_time: type: integer + default: 0 nullable: true description: ' The average wait time in seconds of the members in this queue. This is calculated at the time of the request.' @@ -4290,6 +4300,7 @@ components: in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. max_size: type: integer + default: 0 nullable: true description: ' The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000.' @@ -4433,6 +4444,7 @@ components: in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).' channels: type: integer + default: 0 nullable: true description: 'The number of channels in the final recording file. Can be: `1` or `2`.' @@ -4643,6 +4655,15 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload.recording_add_on_result_payload_data: + type: object + properties: + redirect_to: + type: string + format: uri + nullable: true + description: The URL to redirect to to get the data returned by the AddOn + that was previously stored. api.v2010.account.recording.recording_transcription: type: object properties: @@ -5380,6 +5401,7 @@ components: by Twilio. IPv4 only supported today. cidr_prefix_length: type: integer + default: 0 nullable: true description: An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP @@ -22217,14 +22239,14 @@ paths: readEmpty: value: end: 0 - first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?Page=0&PageSize=50 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0 next_page_uri: null page: 0 page_size: 50 previous_page_uri: null queue_members: [] start: 0 - uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -25648,7 +25670,7 @@ paths: type: boolean examples: readEmpty: - value: true + value: 'true' - name: Coaching in: query description: 'Whether to return only participants who are coaching another @@ -25712,10 +25734,10 @@ paths: readEmpty: value: participants: [] - first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=true&PageSize=50&Page=0 next_page_uri: null previous_page_uri: null - uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=true&PageSize=50&Page=0 page: 0 page_size: 50 end: 0 @@ -25809,8 +25831,8 @@ paths: call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa label: null conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: Sat, 19 Feb 2011 21:07:19 +0000 - date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 end_conference_on_exit: false muted: true hold: false @@ -26532,7 +26554,7 @@ paths: value: end: 0 first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 - next_page_uri: null + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=1&PageToken=PAQUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa page: 0 page_size: 1 previous_page_uri: null @@ -26801,7 +26823,7 @@ paths: description: Friendly name given to the Outbound Track PartialResults: type: boolean - description: Indicates if partial results are going to be send to + description: Indicates if partial results are going to be sent to the customer LanguageCode: type: string @@ -26810,7 +26832,7 @@ paths: TranscriptionEngine: type: string description: Definition of the transcription engine to be used, - between those supported by Twilio + among those supported by Twilio ProfanityFilter: type: boolean description: indicates if the server will attempt to filter out @@ -26819,609 +26841,14 @@ paths: SpeechModel: type: string description: Recognition model used by the transcription engine, - between those supported by the provider + among those supported by the provider Hints: type: string description: A Phrase contains words and phrase "hints" so that the speech recognition engine is more likely to recognize them. EnableAutomaticPunctuation: type: boolean - description: The provider will adds punctuation to recognition result - hypotheses - Parameter1.Name: - type: string - description: Parameter name - Parameter1.Value: - type: string - description: Parameter value - Parameter2.Name: - type: string - description: Parameter name - Parameter2.Value: - type: string - description: Parameter value - Parameter3.Name: - type: string - description: Parameter name - Parameter3.Value: - type: string - description: Parameter value - Parameter4.Name: - type: string - description: Parameter name - Parameter4.Value: - type: string - description: Parameter value - Parameter5.Name: - type: string - description: Parameter name - Parameter5.Value: - type: string - description: Parameter value - Parameter6.Name: - type: string - description: Parameter name - Parameter6.Value: - type: string - description: Parameter value - Parameter7.Name: - type: string - description: Parameter name - Parameter7.Value: - type: string - description: Parameter value - Parameter8.Name: - type: string - description: Parameter name - Parameter8.Value: - type: string - description: Parameter value - Parameter9.Name: - type: string - description: Parameter name - Parameter9.Value: - type: string - description: Parameter value - Parameter10.Name: - type: string - description: Parameter name - Parameter10.Value: - type: string - description: Parameter value - Parameter11.Name: - type: string - description: Parameter name - Parameter11.Value: - type: string - description: Parameter value - Parameter12.Name: - type: string - description: Parameter name - Parameter12.Value: - type: string - description: Parameter value - Parameter13.Name: - type: string - description: Parameter name - Parameter13.Value: - type: string - description: Parameter value - Parameter14.Name: - type: string - description: Parameter name - Parameter14.Value: - type: string - description: Parameter value - Parameter15.Name: - type: string - description: Parameter name - Parameter15.Value: - type: string - description: Parameter value - Parameter16.Name: - type: string - description: Parameter name - Parameter16.Value: - type: string - description: Parameter value - Parameter17.Name: - type: string - description: Parameter name - Parameter17.Value: - type: string - description: Parameter value - Parameter18.Name: - type: string - description: Parameter name - Parameter18.Value: - type: string - description: Parameter value - Parameter19.Name: - type: string - description: Parameter name - Parameter19.Value: - type: string - description: Parameter value - Parameter20.Name: - type: string - description: Parameter name - Parameter20.Value: - type: string - description: Parameter value - Parameter21.Name: - type: string - description: Parameter name - Parameter21.Value: - type: string - description: Parameter value - Parameter22.Name: - type: string - description: Parameter name - Parameter22.Value: - type: string - description: Parameter value - Parameter23.Name: - type: string - description: Parameter name - Parameter23.Value: - type: string - description: Parameter value - Parameter24.Name: - type: string - description: Parameter name - Parameter24.Value: - type: string - description: Parameter value - Parameter25.Name: - type: string - description: Parameter name - Parameter25.Value: - type: string - description: Parameter value - Parameter26.Name: - type: string - description: Parameter name - Parameter26.Value: - type: string - description: Parameter value - Parameter27.Name: - type: string - description: Parameter name - Parameter27.Value: - type: string - description: Parameter value - Parameter28.Name: - type: string - description: Parameter name - Parameter28.Value: - type: string - description: Parameter value - Parameter29.Name: - type: string - description: Parameter name - Parameter29.Value: - type: string - description: Parameter value - Parameter30.Name: - type: string - description: Parameter name - Parameter30.Value: - type: string - description: Parameter value - Parameter31.Name: - type: string - description: Parameter name - Parameter31.Value: - type: string - description: Parameter value - Parameter32.Name: - type: string - description: Parameter name - Parameter32.Value: - type: string - description: Parameter value - Parameter33.Name: - type: string - description: Parameter name - Parameter33.Value: - type: string - description: Parameter value - Parameter34.Name: - type: string - description: Parameter name - Parameter34.Value: - type: string - description: Parameter value - Parameter35.Name: - type: string - description: Parameter name - Parameter35.Value: - type: string - description: Parameter value - Parameter36.Name: - type: string - description: Parameter name - Parameter36.Value: - type: string - description: Parameter value - Parameter37.Name: - type: string - description: Parameter name - Parameter37.Value: - type: string - description: Parameter value - Parameter38.Name: - type: string - description: Parameter name - Parameter38.Value: - type: string - description: Parameter value - Parameter39.Name: - type: string - description: Parameter name - Parameter39.Value: - type: string - description: Parameter value - Parameter40.Name: - type: string - description: Parameter name - Parameter40.Value: - type: string - description: Parameter value - Parameter41.Name: - type: string - description: Parameter name - Parameter41.Value: - type: string - description: Parameter value - Parameter42.Name: - type: string - description: Parameter name - Parameter42.Value: - type: string - description: Parameter value - Parameter43.Name: - type: string - description: Parameter name - Parameter43.Value: - type: string - description: Parameter value - Parameter44.Name: - type: string - description: Parameter name - Parameter44.Value: - type: string - description: Parameter value - Parameter45.Name: - type: string - description: Parameter name - Parameter45.Value: - type: string - description: Parameter value - Parameter46.Name: - type: string - description: Parameter name - Parameter46.Value: - type: string - description: Parameter value - Parameter47.Name: - type: string - description: Parameter name - Parameter47.Value: - type: string - description: Parameter value - Parameter48.Name: - type: string - description: Parameter name - Parameter48.Value: - type: string - description: Parameter value - Parameter49.Name: - type: string - description: Parameter name - Parameter49.Value: - type: string - description: Parameter value - Parameter50.Name: - type: string - description: Parameter name - Parameter50.Value: - type: string - description: Parameter value - Parameter51.Name: - type: string - description: Parameter name - Parameter51.Value: - type: string - description: Parameter value - Parameter52.Name: - type: string - description: Parameter name - Parameter52.Value: - type: string - description: Parameter value - Parameter53.Name: - type: string - description: Parameter name - Parameter53.Value: - type: string - description: Parameter value - Parameter54.Name: - type: string - description: Parameter name - Parameter54.Value: - type: string - description: Parameter value - Parameter55.Name: - type: string - description: Parameter name - Parameter55.Value: - type: string - description: Parameter value - Parameter56.Name: - type: string - description: Parameter name - Parameter56.Value: - type: string - description: Parameter value - Parameter57.Name: - type: string - description: Parameter name - Parameter57.Value: - type: string - description: Parameter value - Parameter58.Name: - type: string - description: Parameter name - Parameter58.Value: - type: string - description: Parameter value - Parameter59.Name: - type: string - description: Parameter name - Parameter59.Value: - type: string - description: Parameter value - Parameter60.Name: - type: string - description: Parameter name - Parameter60.Value: - type: string - description: Parameter value - Parameter61.Name: - type: string - description: Parameter name - Parameter61.Value: - type: string - description: Parameter value - Parameter62.Name: - type: string - description: Parameter name - Parameter62.Value: - type: string - description: Parameter value - Parameter63.Name: - type: string - description: Parameter name - Parameter63.Value: - type: string - description: Parameter value - Parameter64.Name: - type: string - description: Parameter name - Parameter64.Value: - type: string - description: Parameter value - Parameter65.Name: - type: string - description: Parameter name - Parameter65.Value: - type: string - description: Parameter value - Parameter66.Name: - type: string - description: Parameter name - Parameter66.Value: - type: string - description: Parameter value - Parameter67.Name: - type: string - description: Parameter name - Parameter67.Value: - type: string - description: Parameter value - Parameter68.Name: - type: string - description: Parameter name - Parameter68.Value: - type: string - description: Parameter value - Parameter69.Name: - type: string - description: Parameter name - Parameter69.Value: - type: string - description: Parameter value - Parameter70.Name: - type: string - description: Parameter name - Parameter70.Value: - type: string - description: Parameter value - Parameter71.Name: - type: string - description: Parameter name - Parameter71.Value: - type: string - description: Parameter value - Parameter72.Name: - type: string - description: Parameter name - Parameter72.Value: - type: string - description: Parameter value - Parameter73.Name: - type: string - description: Parameter name - Parameter73.Value: - type: string - description: Parameter value - Parameter74.Name: - type: string - description: Parameter name - Parameter74.Value: - type: string - description: Parameter value - Parameter75.Name: - type: string - description: Parameter name - Parameter75.Value: - type: string - description: Parameter value - Parameter76.Name: - type: string - description: Parameter name - Parameter76.Value: - type: string - description: Parameter value - Parameter77.Name: - type: string - description: Parameter name - Parameter77.Value: - type: string - description: Parameter value - Parameter78.Name: - type: string - description: Parameter name - Parameter78.Value: - type: string - description: Parameter value - Parameter79.Name: - type: string - description: Parameter name - Parameter79.Value: - type: string - description: Parameter value - Parameter80.Name: - type: string - description: Parameter name - Parameter80.Value: - type: string - description: Parameter value - Parameter81.Name: - type: string - description: Parameter name - Parameter81.Value: - type: string - description: Parameter value - Parameter82.Name: - type: string - description: Parameter name - Parameter82.Value: - type: string - description: Parameter value - Parameter83.Name: - type: string - description: Parameter name - Parameter83.Value: - type: string - description: Parameter value - Parameter84.Name: - type: string - description: Parameter name - Parameter84.Value: - type: string - description: Parameter value - Parameter85.Name: - type: string - description: Parameter name - Parameter85.Value: - type: string - description: Parameter value - Parameter86.Name: - type: string - description: Parameter name - Parameter86.Value: - type: string - description: Parameter value - Parameter87.Name: - type: string - description: Parameter name - Parameter87.Value: - type: string - description: Parameter value - Parameter88.Name: - type: string - description: Parameter name - Parameter88.Value: - type: string - description: Parameter value - Parameter89.Name: - type: string - description: Parameter name - Parameter89.Value: - type: string - description: Parameter value - Parameter90.Name: - type: string - description: Parameter name - Parameter90.Value: - type: string - description: Parameter value - Parameter91.Name: - type: string - description: Parameter name - Parameter91.Value: - type: string - description: Parameter value - Parameter92.Name: - type: string - description: Parameter name - Parameter92.Value: - type: string - description: Parameter value - Parameter93.Name: - type: string - description: Parameter name - Parameter93.Value: - type: string - description: Parameter value - Parameter94.Name: - type: string - description: Parameter name - Parameter94.Value: - type: string - description: Parameter value - Parameter95.Name: - type: string - description: Parameter name - Parameter95.Value: - type: string - description: Parameter value - Parameter96.Name: - type: string - description: Parameter name - Parameter96.Value: - type: string - description: Parameter value - Parameter97.Name: - type: string - description: Parameter name - Parameter97.Value: - type: string - description: Parameter value - Parameter98.Name: - type: string - description: Parameter name - Parameter98.Value: - type: string - description: Parameter value - Parameter99.Name: - type: string - description: Parameter name - Parameter99.Value: - type: string - description: Parameter value + description: The provider will add punctuation to recognition result examples: createNoArgs: value: {} @@ -28345,30 +27772,354 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListRecordingAddOnResult - /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json: + operationId: ListRecordingAddOnResult + /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json: + servers: + - url: https://api.twilio.com + description: A single Add-on results' payload + x-twilio: + defaultOutputProperties: + - sid + - label + - content_type + dependentProperties: + data: + mapping: + account_sid: account_sid + reference_sid: reference_sid + add_on_result_sid: add_on_result_sid + payload_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json + parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + pathType: instance + get: + description: Fetch an instance of a result payload + tags: + - Api20100401Payload + parameters: + - name: AccountSid + in: path + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording AddOnResult Payload resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + required: true + - name: ReferenceSid + in: path + description: The SID of the recording to which the AddOnResult resource that + contains the payload to fetch belongs. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RE[0-9a-fA-F]{32}$ + required: true + - name: AddOnResultSid + in: path + description: The SID of the AddOnResult to which the payload to fetch belongs. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XR[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Recording + AddOnResult Payload resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XH[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + examples: + fetch: + value: + sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: application/json + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json + 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: FetchRecordingAddOnResultPayload + delete: + description: Delete a payload from the result along with all associated Data + tags: + - Api20100401Payload + parameters: + - name: AccountSid + in: path + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording AddOnResult Payload resources to delete. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + required: true + - name: ReferenceSid + in: path + description: The SID of the recording to which the AddOnResult resource that + contains the payloads to delete belongs. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RE[0-9a-fA-F]{32}$ + required: true + - name: AddOnResultSid + in: path + description: The SID of the AddOnResult to which the payloads to delete belongs. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XR[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Recording + AddOnResult Payload resource to delete. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XH[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteRecordingAddOnResultPayload + /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json: + servers: + - url: https://api.twilio.com + description: A single Add-on results' payload + x-twilio: + defaultOutputProperties: + - sid + - label + - content_type + dependentProperties: + data: + mapping: + account_sid: account_sid + reference_sid: reference_sid + add_on_result_sid: add_on_result_sid + payload_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json + parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + pathType: list + get: + description: Retrieve a list of payloads belonging to the AddOnResult + tags: + - Api20100401Payload + parameters: + - name: AccountSid + in: path + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording AddOnResult Payload resources to read. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + required: true + - name: ReferenceSid + in: path + description: The SID of the recording to which the AddOnResult resource that + contains the payloads to read belongs. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RE[0-9a-fA-F]{32}$ + required: true + - name: AddOnResultSid + in: path + description: The SID of the AddOnResult to which the payloads to read belongs. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XR[0-9a-fA-F]{32}$ + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + title: ListRecordingAddOnResultPayloadResponse + type: object + properties: + payloads: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + payloads: + - sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: application/json + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + payloads: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?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: ListRecordingAddOnResultPayload + /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{PayloadSid}/Data.json: servers: - url: https://api.twilio.com - description: A single Add-on results' payload + description: The Payload Data subresource hosts the actual data returned by the + Add-on x-twilio: defaultOutputProperties: - - sid - - label - - content_type - dependentProperties: - data: - mapping: - account_sid: account_sid - reference_sid: reference_sid - add_on_result_sid: add_on_result_sid - payload_sid: sid - resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json - parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + - redirect_to + parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json pathType: instance get: description: Fetch an instance of a result payload tags: - - Api20100401Payload + - Api20100401Data parameters: - name: AccountSid in: path @@ -28399,7 +28150,7 @@ paths: maxLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: PayloadSid in: path description: The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch. @@ -28410,246 +28161,15 @@ paths: pattern: ^XH[0-9a-fA-F]{32}$ required: true responses: - '200': + '307': content: application/json: schema: - $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload.recording_add_on_result_payload_data' examples: fetch: value: - sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - content_type: application/json - date_created: Wed, 01 Sep 2010 15:15:41 +0000 - date_updated: Wed, 01 Sep 2010 15:15:41 +0000 - subresource_uris: - data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json - 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: FetchRecordingAddOnResultPayload - delete: - description: Delete a payload from the result along with all associated Data - tags: - - Api20100401Payload - parameters: - - name: AccountSid - in: path - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Recording AddOnResult Payload resources to delete. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: ReferenceSid - in: path - description: The SID of the recording to which the AddOnResult resource that - contains the payloads to delete belongs. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RE[0-9a-fA-F]{32}$ - required: true - - name: AddOnResultSid - in: path - description: The SID of the AddOnResult to which the payloads to delete belongs. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XR[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Recording - AddOnResult Payload resource to delete. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XH[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteRecordingAddOnResultPayload - /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json: - servers: - - url: https://api.twilio.com - description: A single Add-on results' payload - x-twilio: - defaultOutputProperties: - - sid - - label - - content_type - dependentProperties: - data: - mapping: - account_sid: account_sid - reference_sid: reference_sid - add_on_result_sid: add_on_result_sid - payload_sid: sid - resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json - parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json - pathType: list - get: - description: Retrieve a list of payloads belonging to the AddOnResult - tags: - - Api20100401Payload - parameters: - - name: AccountSid - in: path - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Recording AddOnResult Payload resources to read. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: ReferenceSid - in: path - description: The SID of the recording to which the AddOnResult resource that - contains the payloads to read belongs. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RE[0-9a-fA-F]{32}$ - required: true - - name: AddOnResultSid - in: path - description: The SID of the AddOnResult to which the payloads to read belongs. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XR[0-9a-fA-F]{32}$ - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - title: ListRecordingAddOnResultPayloadResponse - type: object - properties: - payloads: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' - end: - type: integer - first_page_uri: - format: uri - type: string - next_page_uri: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_uri: - format: uri - nullable: true - type: string - start: - type: integer - uri: - format: uri - type: string - examples: - readFull: - value: - end: 0 - first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 - next_page_uri: null - page: 0 - page_size: 50 - previous_page_uri: null - payloads: - - sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - content_type: application/json - date_created: Wed, 01 Sep 2010 15:15:41 +0000 - date_updated: Wed, 01 Sep 2010 15:15:41 +0000 - subresource_uris: - data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json - start: 0 - uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 - readEmpty: - value: - end: 0 - first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 - next_page_uri: null - page: 0 - page_size: 50 - previous_page_uri: null - payloads: [] - start: 0 - uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + redirect_to: http://example.com headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -28675,10 +28195,10 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: OK + description: Temporary Redirect security: - accountSid_authToken: [] - operationId: ListRecordingAddOnResultPayload + operationId: FetchRecordingAddOnResultPayloadData /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -34764,7 +34284,7 @@ paths: pattern: ^CA[0-9a-fA-F]{32}$ required: true responses: - '201': + '200': content: application/json: schema: @@ -34813,7 +34333,7 @@ paths: schema: type: string example: X-Custom-Header1, X-Custom-Header2 - description: Created + description: OK security: - accountSid_authToken: [] operationId: CreateStream diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index c3bbe24c..e1424db3 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -14,6 +14,7 @@ components: a UTC day size: type: integer + default: 0 nullable: true description: The size of the day's data file in bytes create_date: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index ed50f768..37e16fc1 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -87,10 +87,12 @@ components: deleteSla: 30 members_count: type: integer + default: 0 nullable: true description: The number of Members in the Channel. messages_count: type: integer + default: 0 nullable: true description: The number of Messages in the Channel. url: @@ -419,6 +421,7 @@ components: deleteSla: 30 index: type: integer + default: 0 nullable: true description: The index of the message within the [Channel](https://www.twilio.com/docs/chat/api/channels). url: @@ -578,12 +581,14 @@ components: is enabled for this Service instance. The default is `false`. typing_indicator_timeout: type: integer + default: 0 nullable: true description: How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds. consumption_report_interval: type: integer + default: 0 nullable: true description: DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints. @@ -738,6 +743,7 @@ components: specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. joined_channels_count: type: integer + default: 0 nullable: true description: The number of Channels this User is a Member of. links: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index acb0fd0f..404aaca3 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -183,10 +183,12 @@ components: deleteSla: 30 members_count: type: integer + default: 0 nullable: true description: The number of Members in the Channel. messages_count: type: integer + default: 0 nullable: true description: The number of Messages that have been passed in the Channel. url: @@ -613,6 +615,7 @@ components: deleteSla: 30 index: type: integer + default: 0 nullable: true description: The index of the message within the [Channel](https://www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message @@ -793,12 +796,14 @@ components: is enabled for this Service instance. The default is `false`. typing_indicator_timeout: type: integer + default: 0 nullable: true description: How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds. consumption_report_interval: type: integer + default: 0 nullable: true description: DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints. @@ -838,6 +843,7 @@ components: for more details. pre_webhook_retry_count: type: integer + default: 0 nullable: true description: The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, @@ -845,6 +851,7 @@ components: call won't be retried. post_webhook_retry_count: type: integer + default: 0 nullable: true description: The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, @@ -970,6 +977,7 @@ components: specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. joined_channels_count: type: integer + default: 0 nullable: true description: The number of Channels the User is a Member of. links: diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index b615abb4..9d81a392 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -85,10 +85,12 @@ components: deleteSla: 30 members_count: type: integer + default: 0 nullable: true description: The number of Members in the Channel. messages_count: type: integer + default: 0 nullable: true description: The number of Messages that have been passed in the Channel. messaging_service_sid: diff --git a/spec/yaml/twilio_content_sdk.yaml b/spec/yaml/twilio_content_sdk.yaml index 68aec1d9..44769ede 100644 --- a/spec/yaml/twilio_content_sdk.yaml +++ b/spec/yaml/twilio_content_sdk.yaml @@ -95,6 +95,33 @@ components: required: - type - title + carouselActions: + type: array + items: + $ref: '#/components/schemas/carouselAction' + carouselActionType: + type: string + enum: + - URL + - PHONE_NUMBER + - QUICK_REPLY + carouselAction: + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/carouselActionType' + title: + type: string + url: + type: string + phone: + type: string + id: + type: string + required: + - type + - title authenticationActions: type: array items: @@ -134,6 +161,22 @@ components: type: number description: type: string + carouselCards: + type: array + items: + $ref: '#/components/schemas/carouselCard' + carouselCard: + type: object + additionalProperties: false + properties: + title: + type: string + body: + type: string + media: + type: string + actions: + $ref: '#/components/schemas/carouselActions' twilioText: type: object description: Type containing only plain text-based content @@ -297,6 +340,21 @@ components: type: string required: - body + twilioCarousel: + type: object + description: twilio/carousel templates allow you to send a single text message + accompanied by a set of up to 10 carousel cards in a horizontally scrollable + view + nullable: true + additionalProperties: false + properties: + body: + type: string + cards: + $ref: '#/components/schemas/carouselCards' + required: + - body + - cards ContentApprovalRequest: type: object description: Content approval request body @@ -350,6 +408,8 @@ components: $ref: '#/components/schemas/twilioCard' twilio/catalog: $ref: '#/components/schemas/twilioCatalog' + twilio/carousel: + $ref: '#/components/schemas/twilioCarousel' whatsapp/card: $ref: '#/components/schemas/whatsappCard' whatsapp/authentication: @@ -646,7 +706,7 @@ paths: description: Created security: - accountSid_authToken: [] - operationId: CreateContentApprovalRequest + operationId: CreateApprovalCreate /v1/Content/{ContentSid}/ApprovalRequests: servers: - url: https://content.twilio.com @@ -699,7 +759,7 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchApproval + operationId: FetchApprovalFetch /v1/Content/{Sid}: servers: - url: https://content.twilio.com diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index e1b8b731..4b6c8575 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -322,6 +322,7 @@ components: description: A 34 character string that uniquely identifies this resource. index: type: integer + default: 0 nullable: true description: The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). Indices may skip numbers, but will always be in order of when the message was @@ -476,6 +477,7 @@ components: `undelivered`, `sent` or null. error_code: type: integer + default: 0 nullable: true description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ' @@ -1259,6 +1261,7 @@ components: description: A 34 character string that uniquely identifies this resource. index: type: integer + default: 0 nullable: true description: The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). author: @@ -1419,6 +1422,7 @@ components: `undelivered`, `sent` or null. error_code: type: integer + default: 0 nullable: true description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ' diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index f78f0234..cd916ce2 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -79,6 +79,7 @@ components: in ISO 8601 format. latest_version: type: integer + default: 0 nullable: true description: The latest version published of this schema. events.v1.schema.schema_version: @@ -91,6 +92,7 @@ components: versions, that share the same id. schema_version: type: integer + default: 0 nullable: true description: The version of this schema. date_created: @@ -201,6 +203,7 @@ components: description: Type of event being subscribed to. schema_version: type: integer + default: 0 nullable: true description: The schema version that the Subscription should use. subscription_sid: diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 8a7c0af0..af6ca658 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -339,6 +339,7 @@ components: description: The SID of the Flex Plugin Version. phase: type: integer + default: 0 nullable: true description: The phase this Flex Plugin would initialize at runtime. plugin_url: @@ -508,6 +509,11 @@ components: - studio - external - task + flex_meeting_callback_events_enum_webhook_method: + type: string + enum: + - POST + - GET flex.v1.insights_assessments: type: object properties: @@ -693,6 +699,7 @@ components: description: The unique id of the conversation segment_count: type: integer + default: 0 nullable: true description: The count of segments for a conversation segments: @@ -804,6 +811,7 @@ components: description: The flag to enable for disable NA for answer. usage: type: integer + default: 0 nullable: true description: Integer value that tells a particular question is used by how many questionnaires @@ -9351,6 +9359,8 @@ tags: - name: FlexV1Configuration - name: FlexV1ConfiguredPlugin - name: FlexV1FlexFlow +- name: FlexV1FlexMeetingCallbackEvents +- name: FlexV1FlexTokenInfo - name: FlexV1FlexUser - name: FlexV1FlexVideoOrchestration - name: FlexV1InsightsAssessmentsComment diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index b878621e..774b4015 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -91,6 +91,16 @@ components: type: string nullable: true description: Friendly name of the User. + locale: + type: string + nullable: true + description: The locale preference of the user. + roles: + type: array + items: + type: string + nullable: true + description: The roles of the user. created_date: type: string format: date-time @@ -103,6 +113,7 @@ components: description: The date that this user was updated, given in ISO 8601 format. version: type: integer + default: 0 nullable: true description: The current version of the user. url: @@ -197,8 +208,11 @@ paths: friendly_name: friendly_name username: username email: sample@example.com - created_date: '2015-07-31T04:00:00Z' - updated_date: '2015-07-31T04:00:00Z' + locale: en-US + roles: + - agent + created_date: '2024-07-31T04:00:00Z' + updated_date: '2024-07-31T04:00:00Z' version: 1 url: https://flex-api.twilio.com/v2/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: @@ -230,6 +244,118 @@ paths: security: - accountSid_authToken: [] operationId: FetchFlexUser + post: + description: Update flex user for the given flex user sid + tags: + - FlexV2FlexUser + parameters: + - name: InstanceSid + in: path + description: The unique ID created by Twilio to identify a Flex instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + required: true + - name: FlexUserSid + in: path + description: The unique id for the flex user. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FU[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v2.flex_user' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flex_user_sid: FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flex_team_sid: QOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + first_name: firstname + last_name: lastname + friendly_name: friendly_name + username: username + email: sample@example.com + locale: en-US + roles: + - agent + created_date: '2024-07-31T04:00:00Z' + updated_date: '2024-07-31T04:00:00Z' + version: 1 + url: https://flex-api.twilio.com/v2/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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: UpdateFlexUser + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateFlexUserRequest + properties: + FirstName: + type: string + description: First name of the User. + LastName: + type: string + description: Last name of the User. + Email: + type: string + description: Email of the User. + FriendlyName: + type: string + description: Friendly name of the User. + UserSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + description: The unique SID identifier of the Twilio Unified User. + Locale: + type: string + description: The locale preference of the user. + examples: + update: + value: + Email: sample@example.com /v2/WebChats: servers: - url: https://flex-api.twilio.com diff --git a/spec/yaml/twilio_iam_organizations.yaml b/spec/yaml/twilio_iam_organizations.yaml index fc057545..3e4c4028 100644 --- a/spec/yaml/twilio_iam_organizations.yaml +++ b/spec/yaml/twilio_iam_organizations.yaml @@ -1365,7 +1365,7 @@ paths: type: string format: Sid example: USa36de9717566c7eb6363671f54b87ba9 - - name: scope + - name: Scope in: query required: false schema: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index f63b9818..ce22da13 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -1840,16 +1840,10 @@ paths: description: A destination country code. Based on phone number in To. schema: type: string - - name: Branded - in: query - description: A boolean flag indicating whether or not the calls were branded - using Twilio Branded Calls. - schema: - type: boolean - name: VerifiedCaller in: query description: A boolean flag indicating whether or not the caller was verified - using SHAKEN/STIR. + using SHAKEN/STIR.One of 'true' or 'false'. schema: type: boolean examples: @@ -2003,6 +1997,79 @@ paths: examples: readWithAnnotationParameters: value: 1,2 + - name: BrandedEnabled + in: query + description: A boolean flag indicating whether or not the calls were branded + using Twilio Branded Calls. One of 'true' or 'false' + schema: + type: boolean + examples: + readWithCarrier: + value: true + - name: VoiceIntegrityEnabled + in: query + description: A boolean flag indicating whether or not the phone number had + voice integrity enabled.One of 'true' or 'false' + schema: + type: boolean + examples: + readWithCarrier: + value: true + - name: BrandedBundleSid + in: query + description: A unique SID identifier of the Branded Call. + schema: + type: string + - name: VoiceIntegrityBundleSid + in: query + description: A unique SID identifier of the Voice Integrity Profile. + schema: + type: string + - name: VoiceIntegrityUseCase + in: query + description: A Voice Integrity Use Case . Is of type enum. One of 'abandoned_cart', + 'appointment_reminders', 'appointment_scheduling', 'asset_management', 'automated_support', + 'call_tracking', 'click_to_call', 'contact_tracing', 'contactless_delivery', + 'customer_support', 'dating/social', 'delivery_notifications', 'distance_learning', + 'emergency_notifications', 'employee_notifications', 'exam_proctoring', + 'field_notifications', 'first_responder', 'fraud_alerts', 'group_messaging', + 'identify_&_verification', 'intelligent_routing', 'lead_alerts', 'lead_distribution', + 'lead_generation', 'lead_management', 'lead_nurturing', 'marketing_events', + 'mass_alerts', 'meetings/collaboration', 'order_notifications', 'outbound_dialer', + 'pharmacy', 'phone_system', 'purchase_confirmation', 'remote_appointments', + 'rewards_program', 'self-service', 'service_alerts', 'shift_management', + 'survey/research', 'telehealth', 'telemarketing', 'therapy_(individual+group)'. + schema: + type: string + - name: BusinessProfileIdentity + in: query + description: 'A Business Identity of the calls. Is of type enum. One of ''direct_customer'', + ''isv_reseller_or_partner''. ' + schema: + type: string + - name: BusinessProfileIndustry + in: query + description: 'A Business Industry of the calls. Is of type enum. One of ''automotive'', + ''agriculture'', ''banking'', ''consumer'', ''construction'', ''education'', + ''engineering'', ''energy'', ''oil_and_gas'', ''fast_moving_consumer_goods'', + ''financial'', ''fintech'', ''food_and_beverage'', ''government'', ''healthcare'', + ''hospitality'', ''insurance'', ''legal'', ''manufacturing'', ''media'', + ''online'', ''professional_services'', ''raw_materials'', ''real_estate'', + ''religion'', ''retail'', ''jewelry'', ''technology'', ''telecommunications'', + ''transportation'', ''travel'', ''electronics'', ''not_for_profit'' ' + schema: + type: string + - name: BusinessProfileBundleSid + in: query + description: A unique SID identifier of the Business Profile. + schema: + type: string + - name: BusinessProfileType + in: query + description: A Business Profile Type of the calls. Is of type enum. One of + 'primary', 'secondary'. + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2074,11 +2141,11 @@ paths: meta: page: 0 page_size: 25 - first_page_url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&VoiceIntegrityEnabled=True&StartTime=4h&BrandedEnabled=True&PageSize=25&Page=0 previous_page_url: null next_page_url: null key: call_summaries - url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0 + url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&VoiceIntegrityEnabled=True&StartTime=4h&BrandedEnabled=True&PageSize=25&Page=0 call_summaries: - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -2150,6 +2217,20 @@ paths: trust: verified_caller: verified: true + branded: + enabled: true + display_name: Owl bank + long_display_name: Owl bank Ltd + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + business_profile: + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + identity: direct_customer + industry: BANKING + type: corporate + voice_integrity: + enabled: true + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + use_case: customer_support annotation: null url: https://insights.twilio.com/v1/Voice/Summaries - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -2220,6 +2301,20 @@ paths: trust: verified_caller: verified: true + branded: + enabled: true + display_name: Owl bank + long_display_name: Owl bank Ltd + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + business_profile: + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + identity: direct_customer + industry: BANKING + type: corporate + voice_integrity: + enabled: true + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + use_case: customer_support annotation: null url: https://insights.twilio.com/v1/Voice/Summaries readWithSubaccount: @@ -4425,7 +4520,23 @@ paths: - tags attributes: {} properties: {} - trust: {} + trust: + verified_caller: + verified: true + branded: + enabled: true + display_name: Owl bank + long_display_name: Owl bank Ltd + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + business_profile: + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + identity: direct_customer + industry: BANKING + type: corporate + voice_integrity: + enabled: true + bundle_sid: BU5ceeea51b1424478fc541dfef0e2b167 + use_case: customer_support annotation: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index 48a246ee..ebf0def2 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -44,6 +44,7 @@ components: Type resource. version: type: integer + default: 0 nullable: true description: Numeric Custom Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Custom Operator. @@ -154,6 +155,7 @@ components: Type resource. version: type: integer + default: 0 nullable: true description: Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator. @@ -464,6 +466,7 @@ components: Type resource. version: type: integer + default: 0 nullable: true description: Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator. @@ -507,10 +510,12 @@ components: properties: media_channel: type: integer + default: 0 nullable: true description: The channel number. sentence_index: type: integer + default: 0 nullable: true description: The index of the sentence in the transcript. start_time: @@ -541,6 +546,11 @@ components: confidence: type: number nullable: true + words: + type: array + items: {} + nullable: true + description: Detailed information for each of the words of the given Sentence. intelligence.v2.service: type: object properties: @@ -633,6 +643,7 @@ components: description: Operator sids attached to this service, read only version: type: integer + default: 0 nullable: true description: The version number of this Service. service_enum_http_method: @@ -711,6 +722,7 @@ components: ISO 8601 format. duration: type: integer + default: 0 nullable: true description: The duration of this Transcript's source url: @@ -1294,6 +1306,15 @@ paths: media_url: https://media.server.com/media.wav url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -1869,6 +1890,15 @@ paths: next_page_url: null key: operator_results headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -1965,6 +1995,15 @@ paths: transcript_sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -2154,13 +2193,10 @@ paths: parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this Operator - Type. + description: Either a 34 character string that uniquely identifies this Operator + Type or the unique name that references an Operator Type. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^EY[0-9a-fA-F]{32}$ required: true responses: '200': @@ -2489,6 +2525,7 @@ paths: - start_time - end_time - confidence + - words parent: /Transcripts/{Sid} pathType: list get: @@ -2514,6 +2551,15 @@ paths: examples: readParams: value: 'True' + - name: WordTimestamps + in: query + description: Returns word level timestamps information, if word_timestamps + is enabled. The default is `false`. + schema: + type: boolean + examples: + readParams: + value: 'True' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2579,6 +2625,13 @@ paths: transcript: test test sid: GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa confidence: null + words: + - word: test + start_time: null + end_time: null + - word: test + start_time: null + end_time: null meta: key: sentences page: 0 @@ -2597,15 +2650,31 @@ paths: transcript: test test sid: GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa confidence: null + words: + - word: test + start_time: null + end_time: null + - word: test + start_time: null + end_time: null meta: key: sentences page: 0 page_size: 50 - first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0 - url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&WordTimestamps=True&PageSize=50&Page=0 + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&WordTimestamps=True&PageSize=50&Page=0 next_page_url: null previous_page_url: null headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -2681,6 +2750,15 @@ paths: ETag: schema: type: string + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -2871,6 +2949,15 @@ paths: previous_page_url: null url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -2926,6 +3013,19 @@ paths: responses: '204': description: The resource was deleted successfully. + headers: + ETag: + schema: + type: string + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string security: - accountSid_authToken: [] operationId: DeleteService @@ -2970,6 +3070,15 @@ paths: ETag: schema: type: string + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -3044,6 +3153,15 @@ paths: ETag: schema: type: string + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -3205,6 +3323,15 @@ paths: media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -3461,6 +3588,15 @@ paths: previous_page_url: null url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -3556,6 +3692,15 @@ paths: media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: @@ -3601,6 +3746,16 @@ paths: responses: '204': description: The resource was deleted successfully. + headers: + X-Rate-Limit-Limit: + schema: + type: string + X-Rate-Limit-Remaining: + schema: + type: string + X-Rate-Limit-Config: + schema: + type: string security: - accountSid_authToken: [] operationId: DeleteTranscript diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 31580972..88aba86d 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -51,9 +51,11 @@ components: nullable: true members_count: type: integer + default: 0 nullable: true messages_count: type: integer + default: 0 nullable: true url: type: string @@ -272,6 +274,7 @@ components: nullable: true index: type: integer + default: 0 nullable: true url: type: string @@ -384,9 +387,11 @@ components: nullable: true typing_indicator_timeout: type: integer + default: 0 nullable: true consumption_report_interval: type: integer + default: 0 nullable: true limits: nullable: true @@ -468,6 +473,7 @@ components: nullable: true joined_channels_count: type: integer + default: 0 nullable: true links: type: object diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index 8cdc2c09..e5be4985 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -115,9 +115,11 @@ components: nullable: true members_count: type: integer + default: 0 nullable: true messages_count: type: integer + default: 0 nullable: true url: type: string @@ -407,6 +409,7 @@ components: nullable: true index: type: integer + default: 0 nullable: true type: type: string @@ -529,9 +532,11 @@ components: nullable: true typing_indicator_timeout: type: integer + default: 0 nullable: true consumption_report_interval: type: integer + default: 0 nullable: true limits: nullable: true @@ -551,9 +556,11 @@ components: nullable: true pre_webhook_retry_count: type: integer + default: 0 nullable: true post_webhook_retry_count: type: integer + default: 0 nullable: true notifications: nullable: true @@ -619,6 +626,7 @@ components: nullable: true joined_channels_count: type: integer + default: 0 nullable: true links: type: object diff --git a/spec/yaml/twilio_marketplace_v1.yaml b/spec/yaml/twilio_marketplace_v1.yaml index cba8fca7..7576ddfe 100644 --- a/spec/yaml/twilio_marketplace_v1.yaml +++ b/spec/yaml/twilio_marketplace_v1.yaml @@ -201,7 +201,23 @@ components: description: The absolute URL of the resource. marketplace.v1.installed_add_on.installed_add_on_usage: type: object - properties: {} + properties: + billable_items: + type: array + items: + type: object + properties: + quantity: + type: number + description: Any floating number greater than 0. + sid: + type: string + description: BillingSid to use for billing. + required: + - quantity + - sid + required: + - billable_items marketplace.v1.module_data_management: type: object properties: @@ -209,22 +225,53 @@ components: type: string format: uri nullable: true + description: URL to query the subresource. sid: type: string minLength: 34 maxLength: 34 pattern: ^XB[0-9a-fA-F]{32}$ nullable: true + description: ModuleSid that identifies this Listing. description: nullable: true + description: A JSON object describing the module and is displayed under + the Description tab of the Module detail page. You can define the main + body of the description, highlight key features or aspects of the module + and if applicable, provide code samples for developers support: nullable: true + description: A JSON object containing information on how customers can obtain + support for the module. Use this parameter to provide details such as + contact information and support description. policies: nullable: true + description: A JSON object describing the module's privacy and legal policies + and is displayed under the Policies tab of the Module detail page. The + maximum file size for Policies is 5MB module_info: nullable: true + description: A JSON object containing essential attributes that define a + module. This information is presented on the Module detail page in the + Twilio Marketplace Catalog. You can pass the following attributes in the + JSON object documentation: nullable: true + description: A JSON object for providing comprehensive information, instructions, + and resources related to the module + configuration: + nullable: true + description: A JSON object for providing listing specific configuration. + Contains button setup, notification url, among others. + marketplace.v1.referral_conversion: + type: object + properties: + converted_account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: false info: title: Twilio - Marketplace description: This is the public Twilio REST API. @@ -1430,22 +1477,7 @@ paths: content: application/json: schema: - type: object - properties: - billable_items: - type: array - items: - type: object - properties: - quantity: - type: number - description: '' - sid: - type: string - description: '' - required: - - quantity - - sid + $ref: '#/components/schemas/marketplace.v1.installed_add_on.installed_add_on_usage' examples: multiple_sids: value: @@ -1454,6 +1486,140 @@ paths: quantity: 12.355 - sid: BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa quantity: 44.02 + /v1/ReferralConversion: + servers: + - url: https://marketplace.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + post: + description: '' + tags: + - MarketplaceReferralConversion + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace.v1.referral_conversion' + examples: + create: + value: + converted_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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 + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace.v1.referral_conversion' + examples: + create: + value: + converted_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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: ACCEPTED + '400': + content: + application/json: + schema: + type: object + x-jvm-type: com.twilio.rest.TwilioServiceErrorResponse + 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: NOT_FOUND + security: + - accountSid_authToken: [] + operationId: CreateReferralConversion + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + referral_account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: false + examples: + create: + value: + referral_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Listing/{Sid}: servers: - url: https://marketplace.twilio.com @@ -1514,6 +1680,14 @@ paths: logo_bg_color_hex: '#ff5722' documentation: body: aBody + configuration: + buttons: + - url: https://example.com + label: Configurable button text + help_text: The button text, url, and help text are now configurable + via self service + notification_configuration: + callback_url: https://example.com headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -1567,6 +1741,9 @@ paths: Support: type: string description: '' + Configuration: + type: string + description: '' examples: update: value: @@ -1575,14 +1752,19 @@ paths: Documentation: test Policies: test Support: test + Configuration: test get: - description: '' + description: This endpoint returns the data of a given Listing. To find a Listing's + SID, use the [Available Add-ons resource](/docs/marketplace/api/available-add-ons) + or view its Listing details page in the Console by visiting the [Catalog](https://console.twilio.com/us1/develop/add-ons/catalog) + or the [My Listings tab](https://console.twilio.com/us1/develop/add-ons/publish/my-listings) + and selecting the Listing. tags: - MarketplaceModuleDataManagement parameters: - name: Sid in: path - description: '' + description: The unique identifier of a Listing. schema: type: string minLength: 34 @@ -1627,6 +1809,14 @@ paths: logo_bg_color_hex: '#ff5722' documentation: body: aBody + configuration: + buttons: + - url: https://example.com + label: Configurable button text + help_text: The button text, url, and help text are now configurable + via self service + notification_configuration: + callback_url: https://example.com headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -1666,5 +1856,6 @@ tags: - name: MarketplaceInstalledAddOnExtension - name: MarketplaceInstalledAddOnUsage - name: MarketplaceModuleDataManagement +- name: MarketplaceReferralConversion security: - accountSid_authToken: [] diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index 2d34d63d..9e9e9d17 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -784,6 +784,7 @@ components: description: Reserved. validity_period: type: integer + default: 0 nullable: true description: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. @@ -2782,6 +2783,24 @@ paths: date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sender: messenger:104794531907950 + sender_type: Messenger + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + sender: rcs:ms_dev_ttatqler_agent + sender_type: RCS + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2811,6 +2830,115 @@ paths: security: - accountSid_authToken: [] operationId: ListChannelSender + post: + description: '' + tags: + - MessagingV1ChannelSender + parameters: + - name: MessagingServiceSid + in: path + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + to create the resource under. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.service.channel_sender' + examples: + createwhatsappsender: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sender: whatsapp:+12487960483 + sender_type: WhatsApp + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createfbsender: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sender: messenger:104794531907950 + sender_type: Messanger + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + creatercssender: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + sender: rcs:ms_dev_test_agent + sender_type: RCS + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + 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: CreateChannelSender + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateChannelSenderRequest + properties: + Sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + description: The SID of the Channel Sender being added to the Service. + required: + - Sid + examples: + createwhatsappsender: + value: + Sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createfbsender: + value: + Sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + creatercssender: + value: + Sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}: servers: - url: https://messaging.twilio.com @@ -2851,7 +2979,7 @@ paths: schema: $ref: '#/components/schemas/messaging.v1.service.channel_sender' examples: - fetch: + fetchwhatsappsender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -2862,6 +2990,28 @@ paths: date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchfbsender: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sender: messenger:104794531907950 + sender_type: Messenger + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + fetchrcssender: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + sender: rcs:ms_dev_test_agent + sender_type: RCS + country_code: US + date_created: '2023-07-30T20:12:31Z' + date_updated: '2023-07-30T20:12:33Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -2891,6 +3041,33 @@ paths: security: - accountSid_authToken: [] operationId: FetchChannelSender + delete: + description: '' + tags: + - MessagingV1ChannelSender + parameters: + - name: MessagingServiceSid + in: path + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + to delete the resource from. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the Channel Sender resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteChannelSender /v1/Deactivations: servers: - url: https://messaging.twilio.com @@ -3668,6 +3845,14 @@ paths: pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. + CnpMigration: + type: boolean + description: Customers should use this flag during the ERC registration + process to indicate to Twilio that the campaign being registered + is undergoing CNP migration. It is important for the user to first + trigger the CNP migration process for said campaign in their CSP + portal and have Twilio accept the sharing request, before making + this api call. required: - CampaignId - MessagingServiceSid @@ -3676,6 +3861,7 @@ paths: value: MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa CampaignId: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CnpMigration: false /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}: servers: - url: https://messaging.twilio.com diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 8c6e1815..fcc7e500 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -257,6 +257,7 @@ components: `10`. SMS does not support this property.' ttl: type: integer + default: 0 nullable: true description: How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the diff --git a/spec/yaml/twilio_numbers_v1.yaml b/spec/yaml/twilio_numbers_v1.yaml index 30896a18..ea004765 100644 --- a/spec/yaml/twilio_numbers_v1.yaml +++ b/spec/yaml/twilio_numbers_v1.yaml @@ -170,31 +170,37 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The Account SID that the numbers will be added to after they - are ported into Twilio. + description: Account Sid or subaccount where the phone number(s) will be + Ported notification_emails: type: array items: type: string nullable: true - description: List of emails for getting notifications about the LOA signing - process. Allowed Max 10 emails. + description: Additional emails to send a copy of the signed LOA to. target_port_in_date: type: string format: date nullable: true - description: Minimum number of days in the future (at least 2 days) needs - to be established with the Ops team for validation. + description: "Target date to port the number. We cannot guarantee that this\ + \ date will be honored by the other carriers, please work with Ops to\ + \ get a confirmation of the firm order commitment (FOC) date. Expected\ + \ format is ISO Local Date, example: \u20182011-12-03`. This date must\ + \ be at least 7 days in the future for US ports and 10 days in the future\ + \ for Japanese ports. (This value is only available for custom porting\ + \ customers.)" target_port_in_time_range_start: type: string nullable: true - description: Minimum hour in the future needs to be established with the - Ops team for validation. + description: "The earliest time that the port should occur on the target\ + \ port in date. Expected format is ISO Offset Time, example: \u201810:15:00-08:00'.\ + \ (This value is only available for custom porting customers.)" target_port_in_time_range_end: type: string nullable: true - description: Maximum hour in the future needs to be established with the - Ops team for validation. + description: "The latest time that the port should occur on the target port\ + \ in date. Expected format is ISO Offset Time, example: \u201810:15:00-08:00'.\ + \ (This value is only available for custom porting customers.)" port_in_request_status: type: string nullable: true @@ -203,19 +209,22 @@ components: Required, and Canceled.' losing_carrier_information: nullable: true - description: 'The information for the losing carrier. ' + description: "Details regarding the customer\u2019s information with the\ + \ losing carrier. These values will be used to generate the letter of\ + \ authorization and should match the losing carrier\u2019s data as closely\ + \ as possible to ensure the port is accepted." phone_numbers: type: array items: {} nullable: true - description: The list of phone numbers to Port in. Phone numbers are in - E.164 format (e.g. +16175551212). documents: type: array items: type: string nullable: true - description: The list of documents SID referencing a utility bills + description: List of document SIDs for all phone numbers included in the + port in request. At least one document SID referring to a document of + the type Utility Bill is required. date_created: type: string format: date @@ -229,84 +238,112 @@ components: maxLength: 34 pattern: ^KW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Port In request. This is a unique identifier - of the port in request. + description: The unique identifier for the port in request that this phone + number is associated with. phone_number_sid: type: string minLength: 34 maxLength: 34 pattern: ^PU[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Port In request phone number. This is a unique - identifier of the phone number. + description: The unique identifier for this phone number associated with + this port in request. url: type: string format: uri nullable: true + description: URL reference for this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the account that the phone number belongs to. + description: Account Sid or subaccount where the phone number(s) will be + Ported. phone_number_type: type: string nullable: true - description: The type of the phone number. + description: 'The number type of the phone number. This can be: toll-free, + local, mobile or unknown. This field may be null if the number is not + portable or if the portability for a number has not yet been evaluated.' date_created: type: string format: date-time nullable: true - description: The date when the phone number was created. + description: The timestamp for when this port in phone number was created. country: type: string format: iso-country-code nullable: true - description: The country of the phone number. + description: The ISO country code that this number is associated with. This + field may be null if the number is not portable or if the portability + for a number has not yet been evaluated. missing_required_fields: type: boolean nullable: true - description: The phone number is missing required fields. + description: Indicates if the phone number is missing required fields such + as a PIN or account number. This field may be null if the number is not + portable or if the portability for a number has not yet been evaluated. last_updated: type: string format: date-time nullable: true - description: The timestamp when the status was last updated. + description: Timestamp indicating when the Port In Phone Number resource + was last modified. phone_number: type: string format: phone-number nullable: true - description: The phone number. + description: Phone number to be ported. This will be in the E164 Format. portable: type: boolean nullable: true - description: The phone number is portable. + description: If the number is portable by Twilio or not. This field may + be null if the number portability has not yet been evaluated. If a number + is not portable reference the `not_portability_reason_code` and `not_portability_reason` + fields for more details not_portability_reason: type: string nullable: true - description: The reason why the phone number is not portable. + description: The not portability reason code description. This field may + be null if the number is portable or if the portability for a number has + not yet been evaluated. not_portability_reason_code: type: integer nullable: true - description: The code of the reason why the phone number is not portable. + description: The not portability reason code. This field may be null if + the number is portable or if the portability for a number has not yet + been evaluated. port_in_phone_number_status: type: string nullable: true - description: The status of the phone number in the port in request. + description: The status of the port in phone number. port_out_pin: type: integer nullable: true - description: The pin required for the losing carrier to port out the phone - number. + description: The pin required by the losing carrier to do the port out. rejection_reason: type: string nullable: true - description: The rejection reason returned by the vendor. + description: The description of the rejection reason provided by the losing + carrier. This field may be null if the number has not been rejected by + the losing carrier. rejection_reason_code: type: integer nullable: true - description: The rejection reason code returned by the vendor. + description: The code for the rejection reason provided by the losing carrier. + This field may be null if the number has not been rejected by the losing + carrier. + port_date: + type: string + format: date-time + nullable: true + description: The timestamp the phone number will be ported. This will only + be set once a port date has been confirmed. Not all carriers can guarantee + a specific time on the port date. Twilio will try its best to get the + port completed by this time on the port date. Please subscribe to webhooks + for confirmation on when a port has actually been completed. numbers.v1.porting_portability: type: object properties: @@ -316,22 +353,32 @@ components: nullable: true description: The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212). + x-twilio: + pii: + handling: standard + deleteSla: 0 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The target account sid to which the number will be ported + description: "Account Sid that the phone number belongs to in Twilio. This\ + \ is only returned for phone numbers that already exist in Twilio\u2019\ + s inventory and belong to your account or sub account." portable: type: boolean nullable: true - description: Boolean flag specifying if phone number is portable or not. + description: Boolean flag indicates if the phone number can be ported into + Twilio through the Porting API or not. pin_and_account_number_required: type: boolean nullable: true - description: Boolean flag specifying if PIN and account number is required - for the phone number. + description: Indicates if the port in process will require a personal identification + number (PIN) and an account number for this phone number. If this is true + you will be required to submit both a PIN and account number from the + losing carrier for this number when opening a port in request. These fields + will be required in order to complete the port in process to Twilio. not_portable_reason: type: string nullable: true @@ -341,8 +388,7 @@ components: type: integer nullable: true description: The Portability Reason Code for the phone number if it cannot - be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, - `22133`, `22102` or `22135`. + be ported into Twilio, `null` otherwise. number_type: type: string $ref: '#/components/schemas/porting_portability_enum_number_type' @@ -379,21 +425,23 @@ components: type: string format: uri nullable: true - description: Webhook URL to send a request when a port in request or port - in phone number event happens + description: The complete webhook url that will be called when a notification + event for port in request or port in phone number happens port_out_target_url: type: string format: uri nullable: true - description: Webhook URL to send a request when a port out phone number - event happens + description: The complete webhook url that will be called when a notification + event for a port out phone number happens. notifications_of: type: array items: type: string nullable: true - description: List of notification events to send a request to the webhook - URL + description: A list to filter what notification events to receive for this + account and its sub accounts. If it is an empty list, then it means that + there are no filters for the notifications events to send in each webhook + and all events will get sent. numbers.v1.porting_webhook_configuration_delete: type: object properties: @@ -424,21 +472,23 @@ components: type: string format: uri nullable: true - description: Webhook URL to send a request when a port in request or port - in phone number event happens + description: The complete webhook url that will be called when a notification + event for port in request or port in phone number happens port_out_target_url: type: string format: uri nullable: true - description: Webhook URL to send a request when a port out phone number - event happens + description: The complete webhook url that will be called when a notification + event for a port out phone number happens. notifications_of: type: array items: type: string nullable: true - description: List of notification events to send a request to the webhook - URL + description: A list to filter what notification events to receive for this + account and its sub accounts. If it is an empty list, then it means that + there are no filters for the notifications events to send in each webhook + and all events will get sent. port_in_target_date_created: type: string format: date-time @@ -920,6 +970,7 @@ paths: not_portability_reason_code: 0 port_in_phone_number_sid: PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa port_in_phone_number_status: In Review + port_date: '2023-09-17T00:00:00Z' documents: - ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: @@ -1042,6 +1093,7 @@ paths: port_out_pin: 1234 rejection_reason: null rejection_reason_code: null + port_date: '2024-05-17T00:00:00Z' url: https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumber/PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: @@ -1081,22 +1133,27 @@ paths: mountName: porting_portabilities pathType: instance get: - description: Allows to check if a single phone number can be ported to Twilio - or not. + description: Check if a single phone number can be ported to Twilio tags: - NumbersV1PortingPortability parameters: - name: PhoneNumber in: path - description: The phone number which portability is to be checked. Phone numbers - are in E.164 format (e.g. +16175551212). + description: Phone number to check portability in e164 format. schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 0 required: true - name: TargetAccountSid in: query - description: The SID of the account where the phone number(s) will be ported. + description: Account Sid to which the number will be ported. This can be used + to determine if a sub account already has the number in its inventory or + a different sub account. If this is not provided, the authenticated account + will be assumed to be the target account. schema: type: string minLength: 34 @@ -1160,7 +1217,7 @@ paths: defaultOutputProperties: [] pathType: list post: - description: Allows to create a new webhook configuration + description: Create a Webhook Configuration tags: - NumbersV1PortingWebhookConfiguration responses: @@ -1302,7 +1359,8 @@ paths: parameters: - name: WebhookType in: path - description: The of the webhook type of the configuration to be deleted + description: The webhook type for the configuration to be delete. `PORT_IN`, + `PORT_OUT` schema: type: string $ref: '#/components/schemas/porting_webhook_configuration_delete_enum_webhook_type' @@ -1383,6 +1441,151 @@ paths: type: object title: CreateSigningRequestConfigurationRequest properties: {} + get: + description: Synchronous operation to retrieve configurations for the customer. + tags: + - NumbersV1SigningRequestConfiguration + parameters: + - name: Country + in: query + description: 'The country ISO code to apply this configuration, this is an + optional field, Example: US, MX' + schema: + type: string + examples: + readWithQueryParams: + value: MX + - name: Product + in: query + description: 'The product or service for which is requesting the signature, + this is an optional field, Example: Porting, Hosting' + schema: + type: string + examples: + readWithQueryParams: + value: Porting + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + configurations: + type: array + items: + $ref: '#/components/schemas/numbers.v1.signing_request_configuration' + 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: ListSigningRequestConfigurationResponse + examples: + readWithoutQueryParams: + value: + configurations: + - logo_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Hosting CL + product: Hosting + country: CL + email_subject: Email Subject + email_message: Email Message + url_redirection: https://www.twilio.com/redirect-url + url: https://numbers.twilio.com/v1/SigningRequest/Configuration + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v1/SigningRequest/Configuration?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v1/SigningRequest/Configuration?PageSize=50&Page=0 + next_page_url: null + key: configurations + readWithQueryParams: + value: + configurations: + - logo_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly name + product: Porting + country: MX + email_subject: Email Subject + email_message: Email Message + url_redirection: https://my-redirection-url.com/redirect + url: https://numbers.twilio.com/v1/SigningRequest/Configuration + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v1/SigningRequest/Configuration?Product=Porting&Country=MX&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v1/SigningRequest/Configuration?Product=Porting&Country=MX&PageSize=50&Page=0&PageToken=PTtestPageToken + next_page_url: null + key: configurations + 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: ListSigningRequestConfiguration servers: - url: https://numbers.twilio.com tags: diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index 5b6e3494..97c2153b 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -130,6 +130,7 @@ components: description: The URL of this BulkHostedNumberOrder resource. total_count: type: integer + default: 0 nullable: true description: The total count of phone numbers in this Bulk hosting request. results: @@ -1757,6 +1758,10 @@ paths: type: string description: The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll free`. + IsTest: + type: boolean + description: Indicates that Bundle is a Test Bundle and will be + Auto-Rejected required: - FriendlyName - Email diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index 8e918326..f3178000 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -4,344 +4,194 @@ 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: - type: string - format: date-time - nullable: true - description: Specifies the date this Device was last authenticated, given - in UTC ISO 8601 format. - preview.deployed_devices.fleet: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - nullable: true - description: Contains a 34 character string that uniquely identifies this - Fleet resource. - url: - type: string - format: uri + 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 nullable: true - description: Contains an absolute URL for this Fleet resource. - unique_name: + description: The number of attempts made to verify ownership of the phone + number that is being hosted. + email: type: string nullable: true - description: Contains a unique and addressable name of this Fleet, e.g. - 'default', up to 128 characters long. - friendly_name: - type: string - nullable: true - description: Contains a human readable descriptive text for this Fleet, - up to 256 characters long. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: Speicifies the unique string identifier of the Account responsible - for this Fleet. - default_deployment_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - nullable: true - description: Contains the string identifier of the automatically provisioned - default Deployment of this Fleet. - date_created: - type: string - format: date-time - nullable: true - description: Specifies the date this Fleet was created, given in UTC ISO - 8601 format. - date_updated: - type: string - format: date-time - nullable: true - description: Specifies the date this Fleet was last updated, given in UTC - ISO 8601 format. - links: - type: object - format: uri-map - nullable: true - description: Contains a dictionary of URL links to nested resources of this - Fleet. - preview.deployed_devices.fleet.key: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - nullable: true - description: Contains a 34 character string that uniquely identifies this - Key credential resource. - url: - type: string - format: uri - nullable: true - description: Contains an absolute URL for this Key credential resource. - friendly_name: - type: string - nullable: true - description: Contains a human readable descriptive text for this Key credential, - up to 256 characters long. - fleet_sid: - type: string - nullable: true - description: Specifies the unique string identifier of the Fleet that the - given Key credential belongs to. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: Specifies the unique string identifier of the Account responsible - for this Key credential. - device_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - nullable: true - description: Specifies the unique string identifier of a Device authenticated - with this Key credential. - secret: - type: string - nullable: true - description: Contains the automatically generated secret belonging to this - Key credential, used to authenticate the Device. - date_created: - type: string - format: date-time - nullable: true - description: Specifies the date this Key credential was created, given in - UTC ISO 8601 format. - date_updated: - type: string - format: date-time - nullable: true - description: Specifies the date this Key credential was last updated, given - in UTC ISO 8601 format. - preview.hosted_numbers.authorization_document: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this AuthorizationDocument. - address_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Address - resource that is associated with this AuthorizationDocument. - status: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - nullable: true - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - email: - type: string - nullable: true - description: Email that this AuthorizationDocument will be sent to for signing. + description: Email of the owner of this phone number that is being hosted. x-twilio: pii: handling: standard @@ -352,40 +202,66 @@ components: type: string nullable: true description: Email recipients who will be informed when an Authorization - Document has been sent and signed. + 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: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. - date_updated: + 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 - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - url: + 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 - format: uri nullable: true - links: - type: object - format: uri-map + description: A numerical extension to be used when making the ownership + verification call. + call_delay: + type: integer + default: 0 nullable: true - authorization_document_enum_status: + 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: - - 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 +270,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 +300,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 +322,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 +345,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 @@ -492,6 +371,7 @@ components: 2822](http://www.ietf.org/rfc/rfc2822.txt) format. verification_attempts: type: integer + default: 0 nullable: true description: The number of attempts made to verify ownership of the phone number that is being hosted. @@ -508,18 +388,23 @@ 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' + $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 minLength: 34 @@ -536,13 +421,15 @@ components: verification call. call_delay: type: integer + default: 0 nullable: true description: A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call. verification_code: type: string nullable: true - description: The digits passed during the ownership verification call. + 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: @@ -550,7 +437,7 @@ components: 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: + hosted_number_order_enum_status: type: string enum: - received @@ -562,203 +449,12 @@ components: - completed - failed - 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: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this HostedNumberOrder. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the account. - incoming_phone_number_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) - resource that represents the phone number being hosted. - address_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Address - resource that represents the address of the owner of this phone number. - signing_document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the [Authorization - Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) - the user needs to sign. - phone_number: - type: string - format: phone-number - nullable: true - description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) - format, e.g., +16175551212 - capabilities: - type: object - format: phone-number-capabilities - properties: - mms: - type: boolean - sms: - type: boolean - voice: - type: boolean - fax: - type: boolean - nullable: true - description: Set of booleans describing the capabilities hosted on Twilio's - platform. SMS is currently only supported. - friendly_name: - type: string - nullable: true - description: A 64 character string that is a human-readable text that describes - this resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 - unique_name: - type: string - nullable: true - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in - addition to SID. - x-twilio: - pii: - handling: standard - deleteSla: 30 - status: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - nullable: true - description: 'Status of this resource. It can hold one of the values: 1. - Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, - 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders - Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) - section for more information on each of these statuses.' - failure_reason: - type: string - nullable: true - description: A message that explains why a hosted_number_order went to status - "action-required" - date_created: - type: string - format: date-time - nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. - date_updated: - type: string - format: date-time - nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - verification_attempts: - type: integer - nullable: true - description: The number of attempts made to verify ownership of the phone - number that is being hosted. - email: - type: string - nullable: true - description: Email of the owner of this phone number that is being hosted. - x-twilio: - pii: - handling: standard - deleteSla: 30 - cc_emails: - type: array - items: - type: string - nullable: true - description: A list of emails that LOA document for this HostedNumberOrder - will be carbon copied to. - x-twilio: - pii: - handling: standard - deleteSla: 30 - url: - type: string - format: uri - nullable: true - description: The URL of this HostedNumberOrder. - verification_type: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - nullable: true - description: The type of ownership verification required to move the number - to a `verified` state. The verification methods are `phone-call` or `phone-bill`. - verification_document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Identity - Document resource that represents the document for verifying ownership - of the number to be hosted. - extension: - type: string - nullable: true - description: A numerical extension to be used when making the ownership - verification call. - call_delay: - type: integer - nullable: true - description: A value between 0-30 specifying the number of seconds to delay - initiating the ownership verification call. - verification_code: - type: string - nullable: true - description: A verification code provided in the response for a user to - enter when they pick up the phone call. - verification_call_sids: - type: array - items: - type: string - nullable: true - description: A list of 34 character strings that are unique identifiers - for the calls placed as part of ownership verification. - hosted_number_order_enum_status: - type: string - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - hosted_number_order_enum_verification_type: - type: string - enum: - - phone-call - - phone-bill - preview.marketplace.available_add_on: + preview.marketplace.available_add_on: type: object properties: sid: @@ -932,17 +628,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 +643,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 +675,54 @@ 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: - type: boolean + data_limit: + type: integer + default: 0 nullable: true - description: Boolean flag specifying whether the identity can delete the - Sync Document. - url: - type: string - format: uri + messaging_enabled: + type: boolean 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 +736,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 +754,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 + sms_fallback_method: + type: string + format: http-method + enum: + - GET + - POST nullable: true - account_sid: + sms_fallback_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: uri nullable: true - service_sid: + sms_method: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + format: http-method + enum: + - GET + - POST nullable: true - list_sid: + sms_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ + format: uri nullable: true - url: + voice_fallback_method: + type: string + format: http-method + enum: + - GET + - POST + nullable: true + voice_fallback_url: type: string format: uri nullable: true - revision: + voice_method: type: string + format: http-method + enum: + - GET + - POST nullable: true - data: + voice_url: + type: string + format: uri nullable: true date_created: type: string @@ -1161,413 +831,470 @@ 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: - 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: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ + 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 - revision: - type: string - nullable: true - data: - nullable: true - date_created: - type: string - format: date-time - nullable: true - date_updated: + description: Contains an absolute URL for this Deployment resource. + friendly_name: type: string - format: date-time nullable: true - created_by: + description: Contains a human readable descriptive text for this Deployment, + up to 64 characters long + fleet_sid: 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: + description: Specifies the unique string identifier of the Fleet that the + given Deployment belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + 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: 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: + 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: 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: + description: Specifies the date this Deployment was created, given in UTC + ISO 8601 format. + date_updated: type: string - format: uri + format: date-time nullable: true - description: Contains an absolute URL for this Sync Map Permission. - preview.wireless.command: + description: Specifies the date this Deployment was last updated, given + in UTC ISO 8601 format. + preview.deployed_devices.fleet.device: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - account_sid: + description: Contains a 34 character string that uniquely identifies this + Device resource. + url: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: uri nullable: true - device_sid: + description: Contains an absolute URL for this Device resource. + unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - sim_sid: + description: Contains a unique and addressable name of this Device, assigned + by the developer, up to 128 characters long. + friendly_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - command: + description: Contains a human readable descriptive text for this Device, + up to 256 characters long + fleet_sid: type: string nullable: true - command_mode: + description: Specifies the unique string identifier of the Fleet that the + given Device belongs to. + enabled: + type: boolean + nullable: true + description: Contains a boolean flag indicating whether the device is enabled + or not, blocks device connectivity if set to false. + account_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - status: + description: Specifies the unique string identifier of the Account responsible + for this Device. + identity: type: string nullable: true - direction: + description: Contains an arbitrary string identifier representing a human + user associated with this Device, assigned by the developer, up to 256 + characters long. + deployment_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ nullable: true + description: Specifies the unique string identifier of the Deployment group + that this Device is associated with. date_created: type: string format: date-time nullable: true + description: Specifies the date this Device was created, given in UTC ISO + 8601 format. date_updated: type: string format: date-time nullable: true - url: + description: Specifies the date this Device was last updated, given in UTC + ISO 8601 format. + date_authenticated: type: string - format: uri + format: date-time nullable: true - preview.wireless.rate_plan: + 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: ^WP[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ + nullable: true + description: Contains a 34 character string that uniquely identifies this + Fleet resource. + url: + type: string + format: uri nullable: true + description: Contains an absolute URL for this Fleet resource. unique_name: type: string nullable: true + description: Contains a unique and addressable name of this Fleet, e.g. + 'default', up to 128 characters long. + friendly_name: + type: string + nullable: true + description: Contains a human readable descriptive text for this Fleet, + up to 256 characters long. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - friendly_name: - type: string - nullable: true - data_enabled: - type: boolean - nullable: true - data_metering: + 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 - data_limit: - type: integer - nullable: true - messaging_enabled: - type: boolean - nullable: true - voice_enabled: - type: boolean - nullable: true - national_roaming_enabled: - type: boolean - nullable: true - international_roaming: - type: array - items: - type: string - nullable: true + 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.sim: + 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: ^DE[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 - rate_plan_sid: + description: Specifies the unique string identifier of the Account responsible + for this Key credential. + device_sid: type: string minLength: 34 maxLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - friendly_name: + description: Specifies the unique string identifier of a Device authenticated + with this Key credential. + secret: type: string nullable: true - iccid: + 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 - e_id: + description: Specifies the date this Key credential was created, given in + UTC ISO 8601 format. + date_updated: type: string + format: date-time nullable: true - status: + 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: ^ET[0-9a-fA-F]{32}$ nullable: true - commands_callback_url: + unique_name: type: string - format: uri nullable: true - commands_callback_method: + account_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - sms_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 - sms_fallback_url: + url: type: string format: uri nullable: true - sms_method: + links: + type: object + format: uri-map + nullable: true + revision: type: string - format: http-method - enum: - - GET - - POST nullable: true - sms_url: + data: + nullable: true + date_created: type: string - format: uri + format: date-time nullable: true - voice_fallback_method: + date_updated: type: string - format: http-method - enum: - - GET - - POST + format: date-time nullable: true - voice_fallback_url: + created_by: type: string - format: uri nullable: true - voice_method: + preview.sync.service.document.document_permission: + type: object + properties: + account_sid: type: string - format: http-method - enum: - - GET - - POST + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - voice_url: + description: The unique SID identifier of the Twilio Account. + service_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + nullable: true + description: The unique SID identifier of the Sync Service Instance. + document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^ET[0-9a-fA-F]{32}$ + nullable: true + description: The unique SID identifier of the Sync Document to which the + Permission applies. + identity: + type: string + nullable: true + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + read: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can read the Sync + Document. + write: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can update the + Sync Document. + manage: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can delete the + Sync Document. + url: type: string format: uri nullable: true + description: Contains an absolute URL for this Sync Document Permission. + preview.sync.service: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + nullable: true + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + friendly_name: + type: string + nullable: true date_created: type: string format: date-time @@ -1580,20 +1307,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,82 +1339,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 + nullable: true + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + service_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + nullable: true + list_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true -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' + 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: - 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: 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 @@ -1706,75 +1711,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 +1995,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 +2050,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 +2218,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 +2245,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 +2325,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 +2413,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 +2512,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 +2682,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 +2709,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 +2790,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 +2908,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 +3121,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 +3170,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 +3197,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 +3263,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 +3340,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 +3476,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 +3547,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 +3612,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 +3639,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 +3704,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 +3799,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 +3870,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 +3968,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 +4033,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 +4104,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 +4131,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 +4190,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 +4339,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 +4366,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 +4429,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 +4479,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 +4532,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 +4562,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 +4589,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 +4658,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 +4908,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 +5031,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 +5288,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 +5315,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 +5391,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 +5473,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 +5647,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 +5737,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 +5815,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 +5840,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 +5903,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 +5978,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 +6075,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 +6162,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 +6227,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 +6254,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 +6314,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 +6346,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 +6390,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 +6415,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 +6484,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 +6585,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 +6669,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 +6696,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 +6760,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 +6802,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 +6847,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 +6866,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 +6884,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 +6929,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 +7079,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 +7106,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 +7171,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 +7247,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 +7344,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 +7434,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 +7504,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 +7531,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 +7592,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 +7632,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 +7679,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncList + operationId: FetchSyncDocument delete: description: '' tags: - - PreviewSyncSyncList + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -7637,31 +7705,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 +7833,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 +7880,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 +7938,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 +7965,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 +8029,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 +8053,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 +8111,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 +8126,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 +8217,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 +8270,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 +8302,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 +8329,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 +8389,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 +8424,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 +8474,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 +8489,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 +8559,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 +8718,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 +8745,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 +8810,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 +8821,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 +8856,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 +8865,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 +8900,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMap + operationId: FetchSyncSyncList delete: description: '' tags: - - PreviewSyncSyncMap + - PreviewSyncSyncList parameters: - name: ServiceSid in: path @@ -8826,8 +8926,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 +8937,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 +8966,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 +8975,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 +9010,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 +9028,7 @@ paths: get: description: '' tags: - - PreviewSyncSyncMap + - PreviewSyncSyncList parameters: - name: ServiceSid in: path @@ -8965,10 +9065,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 +9092,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 +9156,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 +9180,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 +9206,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 +9242,11 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapItem + operationId: FetchSyncSyncListItem delete: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewSyncSyncListItem parameters: - name: ServiceSid in: path @@ -9157,17 +9257,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 +9279,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 +9294,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 +9316,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 +9325,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 +9361,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 +9377,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 +9400,7 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: @@ -9311,7 +9411,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 +9420,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 +9456,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 +9486,7 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: ListSid in: path description: '' schema: @@ -9402,7 +9497,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 +9518,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 +9553,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 +9577,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 +9598,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 +9639,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 +9663,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 +9681,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 +9721,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 +9736,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 +9754,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 +9769,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 +9787,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 +9827,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 +9857,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 +9880,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 +9915,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 +9939,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 +9999,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 +10089,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 +10199,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 +10254,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 +10281,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 +10345,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 +10428,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 +10550,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 +10642,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 +10875,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 +10915,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 +10981,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 +11002,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 +11106,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 +11133,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 +11193,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: [] diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index 2ae8d0d1..ce6476d9 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -504,6 +504,7 @@ components: for more information. in_use: type: integer + default: 0 nullable: true description: The number of open session assigned to the number. See the [How many Phone Numbers do I need?](https://www.twilio.com/docs/proxy/phone-numbers-needed) @@ -548,6 +549,7 @@ components: description: The URL we call when the interaction status changes. default_ttl: type: integer + default: 0 nullable: true description: The default `ttl` value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last @@ -695,6 +697,7 @@ components: description: The reason the Session ended. ttl: type: integer + default: 0 nullable: true description: The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction. diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index d8f10c63..64e2f806 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -396,6 +396,7 @@ components: description: 'The status of the Flow. Can be: `draft` or `published`.' version: type: integer + default: 0 nullable: true description: The latest version number of the Flow's definition. date_created: diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 7ec50175..a6e092dc 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -279,6 +279,7 @@ components: description: 'The status of the Flow. Can be: `draft` or `published`.' revision: type: integer + default: 0 nullable: true description: The latest revision number of the Flow's definition. commit_message: @@ -362,6 +363,7 @@ components: description: 'The status of the Flow. Can be: `draft` or `published`.' revision: type: integer + default: 0 nullable: true description: The latest revision number of the Flow's definition. commit_message: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index f1233fda..a0fa53d7 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -214,6 +214,7 @@ components: data connectivity. Defaults to `true`. data_limit: type: integer + default: 0 nullable: true description: The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing @@ -334,6 +335,7 @@ components: \ have its `device_ip` always set." device_port: type: integer + default: 0 nullable: true description: For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index 27d8eea2..0aacfbe7 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -229,6 +229,7 @@ components: reconnections can prevent the `endpoint_disconnected` event. reachability_debouncing_window: type: integer + default: 0 nullable: true description: The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This @@ -347,6 +348,7 @@ components: properties: index: type: integer + default: 0 nullable: true description: The automatically generated index of the List Item. The `index` values of the List Items in a Sync List can have gaps in their sequence. diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 16d04b34..55d0b4f9 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -169,6 +169,7 @@ components: that created the Task resource. age: type: integer + default: 0 nullable: true description: The number of seconds since the Task was created. assignment_status: @@ -213,6 +214,7 @@ components: specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. priority: type: integer + default: 0 nullable: true description: The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before @@ -252,6 +254,7 @@ components: description: The unique name of the TaskChannel. timeout: type: integer + default: 0 nullable: true description: The amount of time in seconds that the Task can live before being assigned. @@ -293,8 +296,14 @@ components: ignore_capacity: type: boolean nullable: true - description: A boolean indicating if a new task should respect a worker's - capacity during assignment + description: 'A boolean that indicates if the Task should respect a Worker''s + capacity and availability during assignment. This field can only be used + when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` + to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker + without respecting their capacity and availability. Any other value will + enforce the Worker''s capacity and availability. The default value of + `IgnoreCapacity` is `true` when the `RoutingTarget` is set to a Worker + SID. ' routing_target: type: string nullable: true @@ -416,6 +425,7 @@ components: deleteSla: 30 max_reserved_workers: type: integer + default: 0 nullable: true description: The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive @@ -538,6 +548,7 @@ components: ' task_queue_response_count: type: integer + default: 0 nullable: true description: The number of TaskQueue statistics received in task_queue_data. url: @@ -558,6 +569,7 @@ components: that created the TaskQueue resource. avg_task_acceptance_time: type: integer + default: 0 nullable: true description: The average time in seconds between Task creation and acceptance. start_time: @@ -575,30 +587,36 @@ components: calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. reservations_created: type: integer + default: 0 nullable: true description: The total number of Reservations created for Tasks in the TaskQueue. reservations_accepted: type: integer + default: 0 nullable: true description: The total number of Reservations accepted for Tasks in the TaskQueue. reservations_rejected: type: integer + default: 0 nullable: true description: The total number of Reservations rejected for Tasks in the TaskQueue. reservations_timed_out: type: integer + default: 0 nullable: true description: The total number of Reservations that timed out for Tasks in the TaskQueue. reservations_canceled: type: integer + default: 0 nullable: true description: The total number of Reservations canceled for Tasks in the TaskQueue. reservations_rescinded: type: integer + default: 0 nullable: true description: The total number of Reservations rescinded. split_by_wait_time: @@ -631,22 +649,27 @@ components: on the time when the Tasks entered the TaskQueue. tasks_canceled: type: integer + default: 0 nullable: true description: The total number of Tasks canceled in the TaskQueue. tasks_completed: type: integer + default: 0 nullable: true description: The total number of Tasks completed in the TaskQueue. tasks_deleted: type: integer + default: 0 nullable: true description: The total number of Tasks deleted in the TaskQueue. tasks_entered: type: integer + default: 0 nullable: true description: The total number of Tasks entered into the TaskQueue. tasks_moved: type: integer + default: 0 nullable: true description: The total number of Tasks that were moved from one queue to another. @@ -680,6 +703,7 @@ components: description: The number of current Workers by Activity. longest_task_waiting_age: type: integer + default: 0 nullable: true description: The age of the longest waiting Task. longest_task_waiting_sid: @@ -691,6 +715,7 @@ components: description: The SID of the longest waiting Task. longest_relative_task_age_in_queue: type: integer + default: 0 nullable: true description: The relative age in the TaskQueue for the longest waiting Task. Calculation is based on the time when the Task entered the TaskQueue. @@ -719,15 +744,18 @@ components: `{"pending": "1", "reserved": "3", "assigned": "2", "completed": "5"}`.' total_available_workers: type: integer + default: 0 nullable: true description: The total number of Workers available for Tasks in the TaskQueue. total_eligible_workers: type: integer + default: 0 nullable: true description: The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state. total_tasks: type: integer + default: 0 nullable: true description: The total number of Tasks. workspace_sid: @@ -1019,6 +1047,7 @@ components: that created the Worker resource. assigned_tasks: type: integer + default: 0 nullable: true description: The total number of Tasks assigned to Worker for the TaskChannel type. @@ -1029,6 +1058,7 @@ components: type. available_capacity_percentage: type: integer + default: 0 nullable: true description: The current percentage of capacity the TaskChannel has available. Can be a number between `0` and `100`. A value of `0` indicates that TaskChannel @@ -1036,6 +1066,7 @@ components: to receive any Tasks of this TaskChannel type. configured_capacity: type: integer + default: 0 nullable: true description: The current configured capacity for the WorkerChannel. TaskRouter will not create any reservations after the assigned Tasks for the Worker @@ -1284,26 +1315,32 @@ components: that Workers spent in each Activity. reservations_created: type: integer + default: 0 nullable: true description: The total number of Reservations that were created. reservations_accepted: type: integer + default: 0 nullable: true description: The total number of Reservations that were accepted. reservations_rejected: type: integer + default: 0 nullable: true description: The total number of Reservations that were rejected. reservations_timed_out: type: integer + default: 0 nullable: true description: The total number of Reservations that were timed out. reservations_canceled: type: integer + default: 0 nullable: true description: The total number of Reservations that were canceled. reservations_rescinded: type: integer + default: 0 nullable: true description: The total number of Reservations that were rescinded. workspace_sid: @@ -1336,6 +1373,7 @@ components: description: The number of current Workers by Activity. total_workers: type: integer + default: 0 nullable: true description: The total number of Workers. workspace_sid: @@ -1414,6 +1452,7 @@ components: resource. task_reservation_timeout: type: integer + default: 0 nullable: true description: How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` @@ -1448,6 +1487,7 @@ components: that created the Workflow resource. avg_task_acceptance_time: type: integer + default: 0 nullable: true description: The average time in seconds between Task creation and acceptance. start_time: @@ -1465,26 +1505,32 @@ components: calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. reservations_created: type: integer + default: 0 nullable: true description: The total number of Reservations that were created for Workers. reservations_accepted: type: integer + default: 0 nullable: true description: The total number of Reservations accepted by Workers. reservations_rejected: type: integer + default: 0 nullable: true description: The total number of Reservations that were rejected. reservations_timed_out: type: integer + default: 0 nullable: true description: The total number of Reservations that were timed out. reservations_canceled: type: integer + default: 0 nullable: true description: The total number of Reservations that were canceled. reservations_rescinded: type: integer + default: 0 nullable: true description: The total number of Reservations that were rescinded. split_by_wait_time: @@ -1502,27 +1548,33 @@ components: for Tasks that were canceled. tasks_canceled: type: integer + default: 0 nullable: true description: The total number of Tasks that were canceled. tasks_completed: type: integer + default: 0 nullable: true description: The total number of Tasks that were completed. tasks_entered: type: integer + default: 0 nullable: true description: The total number of Tasks that entered the Workflow. tasks_deleted: type: integer + default: 0 nullable: true description: The total number of Tasks that were deleted. tasks_moved: type: integer + default: 0 nullable: true description: The total number of Tasks that were moved from one queue to another. tasks_timed_out_in_workflow: type: integer + default: 0 nullable: true description: The total number of Tasks that were timed out of their Workflows (and deleted). @@ -1559,6 +1611,7 @@ components: that created the Workflow resource. longest_task_waiting_age: type: integer + default: 0 nullable: true description: The age of the longest waiting Task. longest_task_waiting_sid: @@ -1578,6 +1631,7 @@ components: `{"pending": "1", "reserved": "3", "assigned": "2", "completed": "5"}`.' total_tasks: type: integer + default: 0 nullable: true description: The total number of Tasks. workflow_sid: @@ -1761,6 +1815,7 @@ components: that created the Workspace resource. avg_task_acceptance_time: type: integer + default: 0 nullable: true description: The average time in seconds between Task creation and acceptance. start_time: @@ -1778,26 +1833,32 @@ components: calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. reservations_created: type: integer + default: 0 nullable: true description: The total number of Reservations that were created for Workers. reservations_accepted: type: integer + default: 0 nullable: true description: The total number of Reservations accepted by Workers. reservations_rejected: type: integer + default: 0 nullable: true description: The total number of Reservations that were rejected. reservations_timed_out: type: integer + default: 0 nullable: true description: The total number of Reservations that were timed out. reservations_canceled: type: integer + default: 0 nullable: true description: The total number of Reservations that were canceled. reservations_rescinded: type: integer + default: 0 nullable: true description: The total number of Reservations that were rescinded. split_by_wait_time: @@ -1815,27 +1876,33 @@ components: for Tasks that were canceled. tasks_canceled: type: integer + default: 0 nullable: true description: The total number of Tasks that were canceled. tasks_completed: type: integer + default: 0 nullable: true description: The total number of Tasks that were completed. tasks_created: type: integer + default: 0 nullable: true description: The total number of Tasks created. tasks_deleted: type: integer + default: 0 nullable: true description: The total number of Tasks that were deleted. tasks_moved: type: integer + default: 0 nullable: true description: The total number of Tasks that were moved from one queue to another. tasks_timed_out_in_workflow: type: integer + default: 0 nullable: true description: The total number of Tasks that were timed out of their Workflows (and deleted). @@ -1869,6 +1936,7 @@ components: description: The number of current Workers by Activity. longest_task_waiting_age: type: integer + default: 0 nullable: true description: The age of the longest waiting Task. longest_task_waiting_sid: @@ -1888,10 +1956,12 @@ components: `{"pending": "1", "reserved": "3", "assigned": "2", "completed": "5"}`.' total_tasks: type: integer + default: 0 nullable: true description: The total number of Tasks. total_workers: type: integer + default: 0 nullable: true description: The total number of Workers in the Workspace. workspace_sid: @@ -3632,8 +3702,15 @@ paths: to IgnoreCapacity: type: string - description: A boolean indicating if a new task should respect a - worker's capacity during assignment + description: 'A boolean that indicates if the Task should respect + a Worker''s capacity and availability during assignment. This + field can only be used when the `RoutingTarget` field is set to + a Worker SID. By setting `IgnoreCapacity` to a value of `true`, + `1`, or `yes`, the Task will be routed to the Worker without respecting + their capacity and availability. Any other value will enforce + the Worker''s capacity and availability. The default value of + `IgnoreCapacity` is `true` when the `RoutingTarget` is set to + a Worker SID. ' TaskQueueSid: type: string minLength: 34 diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 61ac0cc9..6c6bc8e3 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -126,6 +126,7 @@ components: description: The SID of the Trunk that owns the Origination URL. weight: type: integer + default: 0 nullable: true description: The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can @@ -152,6 +153,7 @@ components: description: The string that you assigned to describe the resource. priority: type: integer + default: 0 nullable: true description: The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index d7151fd1..ac947e39 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -872,6 +872,12 @@ paths: inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize + createWithThemeSetId: + value: + inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa + inquiry_session_token: new.session.token + customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -921,6 +927,9 @@ paths: description: The email address that approval status updates will be sent to. If not specified, the email address associated with your primary customer profile will be used. + ThemeSetId: + type: string + description: Theme id for styling the inquiry form. required: - PrimaryProfileSid examples: @@ -931,6 +940,11 @@ paths: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa NotificationEmail: pfarnsworth@twilio.com + createWithThemeSetId: + value: + PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + NotificationEmail: pfarnsworth@twilio.com + ThemeSetId: th_xxxxx /v1/ComplianceInquiries/Customers/{CustomerId}/Initialize: servers: - url: https://trusthub.twilio.com @@ -970,6 +984,12 @@ paths: inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize + updateWithThemeSetId: + value: + inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa + inquiry_session_token: new.session.token + customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource @@ -1014,12 +1034,19 @@ paths: description: The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile. + ThemeSetId: + type: string + description: Theme id for styling the inquiry form. required: - PrimaryProfileSid examples: update: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateWithThemeSetId: + value: + PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ThemeSetId: th_xxxxx /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize: servers: - url: https://trusthub.twilio.com diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 85f6ce7f..9f2b711d 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -59,6 +59,7 @@ components: description: The URL of this resource. ttl: type: integer + default: 0 nullable: true description: 'How long, in seconds, the access token is valid. Max: 5 minutes' date_created: @@ -107,10 +108,12 @@ components: that created the Rate Limit resource. max: type: integer + default: 0 nullable: true description: Maximum number of requests permitted in during the interval. interval: type: integer + default: 0 nullable: true description: Number of seconds that the rate limit will be enforced over. date_created: @@ -711,6 +714,7 @@ components: a sleeping device. ttl: type: integer + default: 0 nullable: true description: 'How long, in seconds, the notification is valid. Max: 5 minutes' date_created: @@ -828,6 +832,7 @@ components: allowed. **This value should not contain PII.** code_length: type: integer + default: 0 nullable: true description: The length of the verification code to generate. lookup_enabled: @@ -866,7 +871,7 @@ components: type: boolean nullable: true description: Whether to allow sending verifications with a custom code instead - of a randomly generated one. Not available for all customers. + of a randomly generated one. push: nullable: true description: Configurations for the Push factors (channel) created under @@ -1152,15 +1157,18 @@ components: properties: total_attempts: type: integer + default: 0 nullable: true description: Total of attempts made according to the provided filters total_converted: type: integer + default: 0 nullable: true description: Total of attempts made that were confirmed by the end user, according to the provided filters. total_unconverted: type: integer + default: 0 nullable: true description: Total of attempts made that were not confirmed by the end user, according to the provided filters. @@ -5384,8 +5392,7 @@ paths: CustomCodeEnabled: type: boolean description: Whether to allow sending verifications with a custom - code instead of a randomly generated one. Not available for all - customers. + code instead of a randomly generated one. Push.IncludeDate: type: boolean description: "Optional configuration for the Push factors. If true,\ @@ -5901,8 +5908,7 @@ paths: CustomCodeEnabled: type: boolean description: Whether to allow sending verifications with a custom - code instead of a randomly generated one. Not available for all - customers. + code instead of a randomly generated one. Push.IncludeDate: type: boolean description: "Optional configuration for the Push factors. If true,\ diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index c39f07f3..042f459b 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -127,6 +127,7 @@ components: for more information. bitrate: type: integer + default: 0 nullable: true description: The average bit rate of the composition's media. size: @@ -136,6 +137,7 @@ components: description: The size of the composed media file in bytes. duration: type: integer + default: 0 nullable: true description: The duration of the composition's media file in seconds. media_external_location: @@ -660,11 +662,13 @@ components: or `group`. The default value is `group`.' max_participants: type: integer + default: 0 nullable: true description: 'The maximum number of concurrent Participants allowed in the room. ' max_participant_duration: type: integer + default: 0 nullable: true description: The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The @@ -704,12 +708,14 @@ components: only. empty_room_timeout: type: integer + default: 0 nullable: true description: Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed. unused_room_timeout: type: integer + default: 0 nullable: true description: Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index 7dea6613..03ae2ea3 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -235,12 +235,14 @@ components: deleteSla: 30 priority: type: integer + default: 0 nullable: true description: The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target. weight: type: integer + default: 0 nullable: true description: The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. @@ -380,6 +382,7 @@ components: properties: update_count: type: integer + default: 0 nullable: true description: The number of countries updated update_request: @@ -446,6 +449,7 @@ components: deleteSla: 30 cidr_prefix_length: type: integer + default: 0 nullable: true description: An integer representing the length of the [CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this IP address. By default the entire IP address is diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index af7b4101..a1829938 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -200,11 +200,13 @@ components: See [Cell Location Estimate Object](https://www.twilio.com/docs/iot/wireless/api/datasession-resource#cell-location-estimate-object). ' packets_uploaded: type: integer + default: 0 nullable: true description: The number of packets uploaded by the device between the `start` time and when the Data Session was last updated. packets_downloaded: type: integer + default: 0 nullable: true description: The number of packets downloaded by the device between the `start` time and when the Data Session was last updated. @@ -274,6 +276,7 @@ components: models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' data_limit: type: integer + default: 0 nullable: true description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile @@ -294,6 +297,7 @@ components: (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming). national_roaming_data_limit: type: integer + default: 0 nullable: true description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United @@ -309,6 +313,7 @@ components: and `messaging`.' international_roaming_data_limit: type: integer + default: 0 nullable: true description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United