From cfdfcd4473e348db2fe554c8f5637bb2e05a1893 Mon Sep 17 00:00:00 2001 From: shwetharadhakrishna Date: Wed, 25 Nov 2020 12:02:56 -0700 Subject: [PATCH 1/7] Splitting up openAPI specs by version. Ref: https://code.hq.twilio.com/twilio/yps/pull/56 --- ..._accounts.json => twilio_accounts_v1.json} | 2 +- ...{twilio_api.json => twilio_api_v2010.json} | 2 +- ...utopilot.json => twilio_autopilot_v1.json} | 2 +- ...xports.json => twilio_bulkexports_v1.json} | 2 +- spec/json/twilio_chat_v1.json | 3875 +++++ .../{twilio_chat.json => twilio_chat_v2.json} | 4275 +---- ...ions.json => twilio_conversations_v1.json} | 2 +- ...ilio_events.json => twilio_events_v1.json} | 2 +- .../{twilio_fax.json => twilio_fax_v1.json} | 2 +- .../{twilio_flex.json => twilio_flex_v1.json} | 2 +- ..._insights.json => twilio_insights_v1.json} | 2 +- ...tudio.json => twilio_ip_messaging_v1.json} | 3324 ++-- ...aging.json => twilio_ip_messaging_v2.json} | 4275 +---- ...io_lookups.json => twilio_lookups_v1.json} | 2 +- ...essaging.json => twilio_messaging_v1.json} | 2 +- ...io_monitor.json => twilio_monitor_v1.json} | 2 +- ...ilio_notify.json => twilio_notify_v1.json} | 2 +- ...io_numbers.json => twilio_numbers_v2.json} | 2 +- spec/json/twilio_preview.json | 13803 ---------------- spec/json/twilio_preview_bulk_exports.json | 710 + .../json/twilio_preview_deployed_devices.json | 1806 ++ spec/json/twilio_preview_hosted_numbers.json | 1276 ++ spec/json/twilio_preview_marketplace.json | 951 ++ spec/json/twilio_preview_sync.json | 3231 ++++ spec/json/twilio_preview_trusted_comms.json | 1238 ++ spec/json/twilio_preview_understand.json | 3588 ++++ spec/json/twilio_preview_wireless.json | 1255 ++ ...io_pricing.json => twilio_pricing_v1.json} | 343 +- spec/json/twilio_pricing_v2.json | 377 + ...twilio_proxy.json => twilio_proxy_v1.json} | 2 +- ...verless.json => twilio_serverless_v1.json} | 2 +- spec/json/twilio_studio_v1.json | 1880 +++ spec/json/twilio_studio_v2.json | 1681 ++ ..._supersim.json => twilio_supersim_v1.json} | 2 +- .../{twilio_sync.json => twilio_sync_v1.json} | 2 +- ...krouter.json => twilio_taskrouter_v1.json} | 2 +- ..._trunking.json => twilio_trunking_v1.json} | 2 +- ...ilio_verify.json => twilio_verify_v2.json} | 2 +- ...twilio_video.json => twilio_video_v1.json} | 2 +- ...twilio_voice.json => twilio_voice_v1.json} | 2 +- ..._wireless.json => twilio_wireless_v1.json} | 2 +- ..._accounts.yaml => twilio_accounts_v1.yaml} | 2 +- ...{twilio_api.yaml => twilio_api_v2010.yaml} | 2 +- ...utopilot.yaml => twilio_autopilot_v1.yaml} | 2 +- ...xports.yaml => twilio_bulkexports_v1.yaml} | 2 +- spec/yaml/twilio_chat_v1.yaml | 2876 ++++ .../{twilio_chat.yaml => twilio_chat_v2.yaml} | 3503 +--- ...ions.yaml => twilio_conversations_v1.yaml} | 2 +- ...ilio_events.yaml => twilio_events_v1.yaml} | 2 +- .../{twilio_fax.yaml => twilio_fax_v1.yaml} | 2 +- .../{twilio_flex.yaml => twilio_flex_v1.yaml} | 2 +- ..._insights.yaml => twilio_insights_v1.yaml} | 2 +- spec/yaml/twilio_ip_messaging_v1.yaml | 2656 +++ ...aging.yaml => twilio_ip_messaging_v2.yaml} | 3283 +--- ...io_lookups.yaml => twilio_lookups_v1.yaml} | 2 +- ...essaging.yaml => twilio_messaging_v1.yaml} | 2 +- ...io_monitor.yaml => twilio_monitor_v1.yaml} | 2 +- ...ilio_notify.yaml => twilio_notify_v1.yaml} | 2 +- ...io_numbers.yaml => twilio_numbers_v2.yaml} | 2 +- spec/yaml/twilio_preview.yaml | 9460 ----------- spec/yaml/twilio_preview_bulk_exports.yaml | 468 + .../yaml/twilio_preview_deployed_devices.yaml | 1242 ++ spec/yaml/twilio_preview_hosted_numbers.yaml | 973 ++ spec/yaml/twilio_preview_marketplace.yaml | 636 + spec/yaml/twilio_preview_sync.yaml | 2139 +++ spec/yaml/twilio_preview_trusted_comms.yaml | 926 ++ spec/yaml/twilio_preview_understand.yaml | 2389 +++ spec/yaml/twilio_preview_wireless.yaml | 862 + ...io_pricing.yaml => twilio_pricing_v1.yaml} | 224 +- spec/yaml/twilio_pricing_v2.yaml | 245 + ...twilio_proxy.yaml => twilio_proxy_v1.yaml} | 2 +- ...verless.yaml => twilio_serverless_v1.yaml} | 2 +- ...ilio_studio.yaml => twilio_studio_v1.yaml} | 1101 +- spec/yaml/twilio_studio_v2.yaml | 1120 ++ ..._supersim.yaml => twilio_supersim_v1.yaml} | 2 +- .../{twilio_sync.yaml => twilio_sync_v1.yaml} | 2 +- ...krouter.yaml => twilio_taskrouter_v1.yaml} | 2 +- ..._trunking.yaml => twilio_trunking_v1.yaml} | 2 +- ...ilio_verify.yaml => twilio_verify_v2.yaml} | 2 +- ...twilio_video.yaml => twilio_video_v1.yaml} | 2 +- ...twilio_voice.yaml => twilio_voice_v1.yaml} | 2 +- ..._wireless.yaml => twilio_wireless_v1.yaml} | 2 +- 82 files changed, 41372 insertions(+), 40715 deletions(-) rename spec/json/{twilio_accounts.json => twilio_accounts_v1.json} (99%) rename spec/json/{twilio_api.json => twilio_api_v2010.json} (99%) rename spec/json/{twilio_autopilot.json => twilio_autopilot_v1.json} (99%) rename spec/json/{twilio_bulkexports.json => twilio_bulkexports_v1.json} (99%) create mode 100644 spec/json/twilio_chat_v1.json rename spec/json/{twilio_chat.json => twilio_chat_v2.json} (57%) rename spec/json/{twilio_conversations.json => twilio_conversations_v1.json} (99%) rename spec/json/{twilio_events.json => twilio_events_v1.json} (99%) rename spec/json/{twilio_fax.json => twilio_fax_v1.json} (99%) rename spec/json/{twilio_flex.json => twilio_flex_v1.json} (99%) rename spec/json/{twilio_insights.json => twilio_insights_v1.json} (99%) rename spec/json/{twilio_studio.json => twilio_ip_messaging_v1.json} (59%) rename spec/json/{twilio_ip_messaging.json => twilio_ip_messaging_v2.json} (56%) rename spec/json/{twilio_lookups.json => twilio_lookups_v1.json} (99%) rename spec/json/{twilio_messaging.json => twilio_messaging_v1.json} (99%) rename spec/json/{twilio_monitor.json => twilio_monitor_v1.json} (99%) rename spec/json/{twilio_notify.json => twilio_notify_v1.json} (99%) rename spec/json/{twilio_numbers.json => twilio_numbers_v2.json} (99%) delete mode 100644 spec/json/twilio_preview.json create mode 100644 spec/json/twilio_preview_bulk_exports.json create mode 100644 spec/json/twilio_preview_deployed_devices.json create mode 100644 spec/json/twilio_preview_hosted_numbers.json create mode 100644 spec/json/twilio_preview_marketplace.json create mode 100644 spec/json/twilio_preview_sync.json create mode 100644 spec/json/twilio_preview_trusted_comms.json create mode 100644 spec/json/twilio_preview_understand.json create mode 100644 spec/json/twilio_preview_wireless.json rename spec/json/{twilio_pricing.json => twilio_pricing_v1.json} (68%) create mode 100644 spec/json/twilio_pricing_v2.json rename spec/json/{twilio_proxy.json => twilio_proxy_v1.json} (99%) rename spec/json/{twilio_serverless.json => twilio_serverless_v1.json} (99%) create mode 100644 spec/json/twilio_studio_v1.json create mode 100644 spec/json/twilio_studio_v2.json rename spec/json/{twilio_supersim.json => twilio_supersim_v1.json} (99%) rename spec/json/{twilio_sync.json => twilio_sync_v1.json} (99%) rename spec/json/{twilio_taskrouter.json => twilio_taskrouter_v1.json} (99%) rename spec/json/{twilio_trunking.json => twilio_trunking_v1.json} (99%) rename spec/json/{twilio_verify.json => twilio_verify_v2.json} (99%) rename spec/json/{twilio_video.json => twilio_video_v1.json} (99%) rename spec/json/{twilio_voice.json => twilio_voice_v1.json} (99%) rename spec/json/{twilio_wireless.json => twilio_wireless_v1.json} (99%) rename spec/yaml/{twilio_accounts.yaml => twilio_accounts_v1.yaml} (99%) rename spec/yaml/{twilio_api.yaml => twilio_api_v2010.yaml} (99%) rename spec/yaml/{twilio_autopilot.yaml => twilio_autopilot_v1.yaml} (99%) rename spec/yaml/{twilio_bulkexports.yaml => twilio_bulkexports_v1.yaml} (99%) create mode 100644 spec/yaml/twilio_chat_v1.yaml rename spec/yaml/{twilio_chat.yaml => twilio_chat_v2.yaml} (57%) rename spec/yaml/{twilio_conversations.yaml => twilio_conversations_v1.yaml} (99%) rename spec/yaml/{twilio_events.yaml => twilio_events_v1.yaml} (99%) rename spec/yaml/{twilio_fax.yaml => twilio_fax_v1.yaml} (99%) rename spec/yaml/{twilio_flex.yaml => twilio_flex_v1.yaml} (99%) rename spec/yaml/{twilio_insights.yaml => twilio_insights_v1.yaml} (99%) create mode 100644 spec/yaml/twilio_ip_messaging_v1.yaml rename spec/yaml/{twilio_ip_messaging.yaml => twilio_ip_messaging_v2.yaml} (56%) rename spec/yaml/{twilio_lookups.yaml => twilio_lookups_v1.yaml} (99%) rename spec/yaml/{twilio_messaging.yaml => twilio_messaging_v1.yaml} (99%) rename spec/yaml/{twilio_monitor.yaml => twilio_monitor_v1.yaml} (99%) rename spec/yaml/{twilio_notify.yaml => twilio_notify_v1.yaml} (99%) rename spec/yaml/{twilio_numbers.yaml => twilio_numbers_v2.yaml} (99%) delete mode 100644 spec/yaml/twilio_preview.yaml create mode 100644 spec/yaml/twilio_preview_bulk_exports.yaml create mode 100644 spec/yaml/twilio_preview_deployed_devices.yaml create mode 100644 spec/yaml/twilio_preview_hosted_numbers.yaml create mode 100644 spec/yaml/twilio_preview_marketplace.yaml create mode 100644 spec/yaml/twilio_preview_sync.yaml create mode 100644 spec/yaml/twilio_preview_trusted_comms.yaml create mode 100644 spec/yaml/twilio_preview_understand.yaml create mode 100644 spec/yaml/twilio_preview_wireless.yaml rename spec/yaml/{twilio_pricing.yaml => twilio_pricing_v1.yaml} (67%) create mode 100644 spec/yaml/twilio_pricing_v2.yaml rename spec/yaml/{twilio_proxy.yaml => twilio_proxy_v1.yaml} (99%) rename spec/yaml/{twilio_serverless.yaml => twilio_serverless_v1.yaml} (99%) rename spec/yaml/{twilio_studio.yaml => twilio_studio_v1.yaml} (54%) create mode 100644 spec/yaml/twilio_studio_v2.yaml rename spec/yaml/{twilio_supersim.yaml => twilio_supersim_v1.yaml} (99%) rename spec/yaml/{twilio_sync.yaml => twilio_sync_v1.yaml} (99%) rename spec/yaml/{twilio_taskrouter.yaml => twilio_taskrouter_v1.yaml} (99%) rename spec/yaml/{twilio_trunking.yaml => twilio_trunking_v1.yaml} (99%) rename spec/yaml/{twilio_verify.yaml => twilio_verify_v2.yaml} (99%) rename spec/yaml/{twilio_video.yaml => twilio_video_v1.yaml} (99%) rename spec/yaml/{twilio_voice.yaml => twilio_voice_v1.yaml} (99%) rename spec/yaml/{twilio_wireless.yaml => twilio_wireless_v1.yaml} (99%) diff --git a/spec/json/twilio_accounts.json b/spec/json/twilio_accounts_v1.json similarity index 99% rename from spec/json/twilio_accounts.json rename to spec/json/twilio_accounts_v1.json index f43d12f8..660d99cc 100644 --- a/spec/json/twilio_accounts.json +++ b/spec/json/twilio_accounts_v1.json @@ -142,7 +142,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Accounts", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_api.json b/spec/json/twilio_api_v2010.json similarity index 99% rename from spec/json/twilio_api.json rename to spec/json/twilio_api_v2010.json index 34ca449f..4e1f5e74 100644 --- a/spec/json/twilio_api.json +++ b/spec/json/twilio_api_v2010.json @@ -7227,7 +7227,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Api", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_autopilot.json b/spec/json/twilio_autopilot_v1.json similarity index 99% rename from spec/json/twilio_autopilot.json rename to spec/json/twilio_autopilot_v1.json index 78cff008..25acdd25 100644 --- a/spec/json/twilio_autopilot.json +++ b/spec/json/twilio_autopilot_v1.json @@ -690,7 +690,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Autopilot", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_bulkexports.json b/spec/json/twilio_bulkexports_v1.json similarity index 99% rename from spec/json/twilio_bulkexports.json rename to spec/json/twilio_bulkexports_v1.json index 361aaf61..4b7d38bc 100644 --- a/spec/json/twilio_bulkexports.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -162,7 +162,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Bulkexports", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json new file mode 100644 index 00000000..09bd3f7c --- /dev/null +++ b/spec/json/twilio_chat_v1.json @@ -0,0 +1,3875 @@ +{ + "components": { + "schemas": { + "chat.v1.credential": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "sandbox": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": { + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v1.service": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "consumption_report_interval": { + "type": "integer" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "default_channel_creator_role_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "default_channel_role_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "default_service_role_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "limits": { + "type": "object" + }, + "links": { + "type": "object" + }, + "notifications": { + "type": "object" + }, + "post_webhook_url": { + "type": "string" + }, + "pre_webhook_url": { + "type": "string" + }, + "reachability_enabled": { + "type": "boolean" + }, + "read_status_enabled": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "typing_indicator_timeout": { + "type": "integer" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_filters": { + "items": { + "type": "string" + }, + "type": "array" + }, + "webhook_method": { + "type": "string" + }, + "webhooks": { + "type": "object" + } + }, + "type": "object" + }, + "chat.v1.service.channel": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "attributes": { + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "members_count": { + "type": "integer" + }, + "messages_count": { + "type": "integer" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": { + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v1.service.channel.invite": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "identity": { + "type": "string" + }, + "role_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IN[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v1.service.channel.member": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "identity": { + "type": "string" + }, + "last_consumed_message_index": { + "nullable": true, + "type": "integer" + }, + "last_consumption_timestamp": { + "format": "date-time", + "type": "string" + }, + "role_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MB[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v1.service.channel.message": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "attributes": { + "type": "string" + }, + "body": { + "type": "string" + }, + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "from": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + }, + "to": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "was_edited": { + "type": "boolean" + } + }, + "type": "object" + }, + "chat.v1.service.role": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "permissions": { + "items": { + "type": "string" + }, + "type": "array" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": { + "enum": [ + "channel", + "deployment" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v1.service.user": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "attributes": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "identity": { + "type": "string" + }, + "is_notifiable": { + "type": "boolean" + }, + "is_online": { + "type": "boolean" + }, + "joined_channels_count": { + "type": "integer" + }, + "links": { + "type": "object" + }, + "role_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^US[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v1.service.user.user_channel": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "last_consumed_message_index": { + "nullable": true, + "type": "integer" + }, + "links": { + "type": "object" + }, + "member_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MB[0-9a-fA-F]{32}$", + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "joined", + "invited", + "not_participating" + ], + "type": "string" + }, + "unread_messages_count": { + "nullable": true, + "type": "integer" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Chat", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/Credentials": { + "description": "Credentials for push notifications channels", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "credentials": { + "items": { + "$ref": "#/components/schemas/chat.v1.credential" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", + "type": "string" + }, + "Type": { + "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.", + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.credential" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "type" + ], + "x-path-type": "list" + }, + "/v1/Credentials/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The Twilio-provided string that uniquely identifies the Credential resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Credentials for push notifications channels", + "get": { + "description": "", + "parameters": [ + { + "description": "The Twilio-provided string that uniquely identifies the Credential resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.credential" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The Twilio-provided string that uniquely identifies the Credential resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.credential" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "type" + ], + "x-path-type": "instance" + }, + "/v1/Services": { + "description": "Top level scope for all chat resources", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "services": { + "items": { + "$ref": "#/components/schemas/chat.v1.service" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Channels": { + "description": "Channels represent chat rooms", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.", + "in": "query", + "name": "Type", + "schema": { + "items": { + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "Type": { + "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`.", + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "unique_name", + "friendly_name" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { + "description": "Pending invitations to users to become channel members", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resources to read belong to.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", + "in": "query", + "name": "Identity", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "invites": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.channel.invite" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new resource belongs to.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new member.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.invite" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "identity", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to delete belongs to.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Invite resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Pending invitations to users to become channel members", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to fetch belongs to.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Invite resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.invite" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "identity", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members": { + "description": "Users joined to specific channels", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the members to read belong to. Can be the Channel resource's `sid` or `unique_name` value.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", + "in": "query", + "name": "Identity", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new member belongs to. Can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.member" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "identity", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Member resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MB[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Users joined to specific channels", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Member resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MB[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.member" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to update belongs to. Can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Member resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MB[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "LastConsumedMessageIndex": { + "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels).", + "nullable": true, + "type": "integer" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.member" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "identity", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages": { + "description": "Individual chat messages", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to read belongs to. Can be the Channel's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.", + "in": "query", + "name": "Order", + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "messages": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new resource belongs to. Can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "Body": { + "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", + "type": "string" + }, + "From": { + "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.", + "type": "string" + } + }, + "required": [ + "Body" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.message" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "from", + "to", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to delete belongs to. Can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Message resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Individual chat messages", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to fetch belongs to. Can be the Channel's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Message resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.message" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Message resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "Body": { + "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel.message" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "from", + "to", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Channels/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Channel resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Channels represent chat rooms", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Channel resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Channel resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.channel" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "unique_name", + "friendly_name" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Roles": { + "description": "Roles determining user or member permissions", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "roles": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.role" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "Permission": { + "description": "A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Type": { + "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) roles.", + "enum": [ + "channel", + "deployment" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Type", + "Permission" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.role" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "type" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Roles/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Role resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Roles determining user or member permissions", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Role resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.role" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Role resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Permission": { + "description": "A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Permission" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.role" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "type" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Users": { + "description": "Unique chat users within a chat service", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "users": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.user" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. This value is often used for display purposes.", + "type": "string" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is often a username or email address. See the Identity documentation for more details.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new User.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.user" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Users/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the User resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Unique chat users within a chat service", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the User resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.user" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the User resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It is often used for display purposes.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service.user" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { + "description": "TODO: Resource-level docs", + "get": { + "description": "List all Channels for a given User.", + "parameters": [ + { + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the [User](https://www.twilio.com/docs/api/chat/rest/users) to read the User Channel resources from.", + "in": "path", + "name": "UserSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/chat.v1.service.user.user_channel" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "channel_sid", + "status" + ], + "x-path-type": "list" + }, + "/v1/Services/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The Twilio-provided string that uniquely identifies the Service resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Top level scope for all chat resources", + "get": { + "description": "", + "parameters": [ + { + "description": "The Twilio-provided string that uniquely identifies the Service resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The Twilio-provided string that uniquely identifies the Service resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ConsumptionReportInterval": { + "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.", + "type": "integer" + }, + "DefaultChannelCreatorRoleSid": { + "description": "The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultChannelRoleSid": { + "description": "The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultServiceRoleSid": { + "description": "The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Limits.ChannelMembers": { + "description": "The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.", + "type": "integer" + }, + "Limits.UserChannels": { + "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.", + "type": "integer" + }, + "Notifications.AddedToChannel.Enabled": { + "description": "Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.AddedToChannel.Template": { + "description": "The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.InvitedToChannel.Enabled": { + "description": "Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.InvitedToChannel.Template": { + "description": "The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.NewMessage.Enabled": { + "description": "Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.NewMessage.Template": { + "description": "The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", + "type": "string" + }, + "Notifications.RemovedFromChannel.Enabled": { + "description": "Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.RemovedFromChannel.Template": { + "description": "The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", + "type": "string" + }, + "PostWebhookUrl": { + "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", + "format": "uri", + "type": "string" + }, + "PreWebhookUrl": { + "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", + "format": "uri", + "type": "string" + }, + "ReachabilityEnabled": { + "description": "Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.", + "type": "boolean" + }, + "ReadStatusEnabled": { + "description": "Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.", + "type": "boolean" + }, + "TypingIndicatorTimeout": { + "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.", + "type": "integer" + }, + "WebhookFilters": { + "description": "The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "WebhookMethod": { + "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdd.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_add.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdd.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelAdded.Method": { + "description": "The URL of the webhook to call in response to the `on_channel_added` event`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdded.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelDestroy.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelDestroy.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelDestroyed.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelDestroyed.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelUpdate.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_update.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelUpdate.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelUpdated.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelUpdated.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberAdd.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_member_add.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberAdd.Url": { + "description": "The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberAdded.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberAdded.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberRemove.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_member_remove.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberRemove.Url": { + "description": "The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberRemoved.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_member_removed.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberRemoved.Url": { + "description": "The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageRemove.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_remove.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageRemove.Url": { + "description": "The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageRemoved.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_removed.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageRemoved.Url": { + "description": "The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageSend.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_send.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageSend.Url": { + "description": "The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageSent.Method": { + "description": "The URL of the webhook to call in response to the `on_message_sent` event`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageSent.Url": { + "description": "The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageUpdate.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_update.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageUpdate.Url": { + "description": "The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageUpdated.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_updated.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageUpdated.Url": { + "description": "The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chat.v1.service" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://chat.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "date_created" + ], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "This product is Generally Available.", + "name": "GA" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_chat.json b/spec/json/twilio_chat_v2.json similarity index 57% rename from spec/json/twilio_chat.json rename to spec/json/twilio_chat_v2.json index a14b5977..3c5c0493 100644 --- a/spec/json/twilio_chat.json +++ b/spec/json/twilio_chat_v2.json @@ -1,7 +1,7 @@ { "components": { "schemas": { - "chat.v1.credential": { + "chat.v2.credential": { "properties": { "account_sid": { "maxLength": 34, @@ -44,7 +44,7 @@ }, "type": "object" }, - "chat.v1.service": { + "chat.v2.service": { "properties": { "account_sid": { "maxLength": 34, @@ -90,12 +90,21 @@ "links": { "type": "object" }, + "media": { + "type": "object" + }, "notifications": { "type": "object" }, + "post_webhook_retry_count": { + "type": "integer" + }, "post_webhook_url": { "type": "string" }, + "pre_webhook_retry_count": { + "type": "integer" + }, "pre_webhook_url": { "type": "string" }, @@ -126,14 +135,75 @@ }, "webhook_method": { "type": "string" + } + }, + "type": "object" + }, + "chat.v2.service.binding": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "binding_type": { + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + }, + "credential_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "endpoint": { + "type": "string" + }, + "identity": { + "type": "string" }, - "webhooks": { + "links": { "type": "object" + }, + "message_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" } }, "type": "object" }, - "chat.v1.service.channel": { + "chat.v2.service.channel": { "properties": { "account_sid": { "maxLength": 34, @@ -196,7 +266,54 @@ }, "type": "object" }, - "chat.v1.service.channel.invite": { + "chat.v2.service.channel.channel_webhook": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "configuration": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WH[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "chat.v2.service.channel.invite": { "properties": { "account_sid": { "maxLength": 34, @@ -249,7 +366,7 @@ }, "type": "object" }, - "chat.v1.service.channel.member": { + "chat.v2.service.channel.member": { "properties": { "account_sid": { "maxLength": 34, @@ -257,6 +374,9 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, + "attributes": { + "type": "string" + }, "channel_sid": { "maxLength": 34, "minLength": 34, @@ -307,7 +427,7 @@ }, "type": "object" }, - "chat.v1.service.channel.message": { + "chat.v2.service.channel.message": { "properties": { "account_sid": { "maxLength": 34, @@ -341,6 +461,12 @@ "index": { "type": "integer" }, + "last_updated_by": { + "type": "string" + }, + "media": { + "type": "object" + }, "service_sid": { "maxLength": 34, "minLength": 34, @@ -359,6 +485,9 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, + "type": { + "type": "string" + }, "url": { "format": "uri", "type": "string" @@ -369,7 +498,7 @@ }, "type": "object" }, - "chat.v1.service.role": { + "chat.v2.service.role": { "properties": { "account_sid": { "maxLength": 34, @@ -420,7 +549,7 @@ }, "type": "object" }, - "chat.v1.service.user": { + "chat.v2.service.user": { "properties": { "account_sid": { "maxLength": 34, @@ -482,7 +611,7 @@ }, "type": "object" }, - "chat.v1.service.user.user_channel": { + "chat.v2.service.user.user_binding": { "properties": { "account_sid": { "maxLength": 34, @@ -490,52 +619,18 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "last_consumed_message_index": { - "nullable": true, - "type": "integer" - }, - "links": { - "type": "object" - }, - "member_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { + "binding_type": { "enum": [ - "joined", - "invited", - "not_participating" + "gcm", + "apn", + "fcm" ], "type": "string" }, - "unread_messages_count": { - "nullable": true, - "type": "integer" - } - }, - "type": "object" - }, - "chat.v2.credential": { - "properties": { - "account_sid": { + "credential_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" }, "date_created": { @@ -546,34 +641,44 @@ "format": "date-time", "type": "string" }, - "friendly_name": { + "endpoint": { "type": "string" }, - "sandbox": { + "identity": { "type": "string" }, - "sid": { + "message_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "type": { - "enum": [ - "gcm", - "apn", - "fcm" - ], + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BS[0-9a-fA-F]{32}$", "type": "string" }, "url": { "format": "uri", "type": "string" + }, + "user_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^US[0-9a-fA-F]{32}$", + "type": "string" } }, "type": "object" }, - "chat.v2.service": { + "chat.v2.service.user.user_channel": { "properties": { "account_sid": { "maxLength": 34, @@ -581,4032 +686,88 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "consumption_report_interval": { - "type": "integer" - }, - "date_created": { - "format": "date-time", + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, - "date_updated": { - "format": "date-time", - "type": "string" + "last_consumed_message_index": { + "nullable": true, + "type": "integer" }, - "default_channel_creator_role_sid": { + "links": { + "type": "object" + }, + "member_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" }, - "default_channel_role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", + "notification_level": { + "enum": [ + "default", + "muted" + ], "type": "string" }, - "default_service_role_sid": { + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "friendly_name": { + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "limits": { - "type": "object" - }, - "links": { - "type": "object" - }, - "media": { - "type": "object" - }, - "notifications": { - "type": "object" - }, - "post_webhook_retry_count": { - "type": "integer" - }, - "post_webhook_url": { - "type": "string" - }, - "pre_webhook_retry_count": { - "type": "integer" - }, - "pre_webhook_url": { - "type": "string" - }, - "reachability_enabled": { - "type": "boolean" - }, - "read_status_enabled": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "typing_indicator_timeout": { - "type": "integer" - }, - "url": { - "format": "uri", - "type": "string" - }, - "webhook_filters": { - "items": { - "type": "string" - }, - "type": "array" - }, - "webhook_method": { - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.binding": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "binding_type": { + "status": { "enum": [ - "gcm", - "apn", - "fcm" + "joined", + "invited", + "not_participating" ], "type": "string" }, - "credential_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "endpoint": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "links": { - "type": "object" - }, - "message_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.channel": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "created_by": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "members_count": { - "type": "integer" - }, - "messages_count": { + "unread_messages_count": { + "nullable": true, "type": "integer" }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "unique_name": { - "type": "string" - }, "url": { "format": "uri", "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.channel.channel_webhook": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "configuration": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" }, - "sid": { + "user_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^WH[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "format": "uri", + "pattern": "^US[0-9a-fA-F]{32}$", "type": "string" } }, "type": "object" - }, - "chat.v2.service.channel.invite": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "identity": { - "type": "string" - }, - "role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IN[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.channel.member": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "identity": { - "type": "string" - }, - "last_consumed_message_index": { - "nullable": true, - "type": "integer" - }, - "last_consumption_timestamp": { - "format": "date-time", - "type": "string" - }, - "role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.channel.message": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "body": { - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "from": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "last_updated_by": { - "type": "string" - }, - "media": { - "type": "object" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - }, - "to": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "was_edited": { - "type": "boolean" - } - }, - "type": "object" - }, - "chat.v2.service.role": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "permissions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "enum": [ - "channel", - "deployment" - ], - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.user": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "is_notifiable": { - "type": "boolean" - }, - "is_online": { - "type": "boolean" - }, - "joined_channels_count": { - "type": "integer" - }, - "links": { - "type": "object" - }, - "role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.user.user_binding": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "binding_type": { - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - }, - "credential_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "endpoint": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "message_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "user_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "chat.v2.service.user.user_channel": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "last_consumed_message_index": { - "nullable": true, - "type": "integer" - }, - "links": { - "type": "object" - }, - "member_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - }, - "notification_level": { - "enum": [ - "default", - "muted" - ], - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "joined", - "invited", - "not_participating" - ], - "type": "string" - }, - "unread_messages_count": { - "nullable": true, - "type": "integer" - }, - "url": { - "format": "uri", - "type": "string" - }, - "user_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - }, - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - } - }, - "info": { - "contact": { - "email": "support@twilio.com", - "name": "Twilio Support", - "url": "https://support.twilio.com" - }, - "description": "This is the public Twilio REST API.", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Chat", - "version": "1.3.0" - }, - "openapi": "3.0.1", - "paths": { - "/v1/Credentials": { - "description": "Credentials for push notifications channels", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "credentials": { - "items": { - "$ref": "#/components/schemas/chat.v1.credential" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiKey": { - "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", - "type": "string" - }, - "Certificate": { - "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "type": "string" - }, - "PrivateKey": { - "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", - "type": "string" - }, - "Sandbox": { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "type": "boolean" - }, - "Secret": { - "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", - "type": "string" - }, - "Type": { - "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.", - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.credential" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "list" - }, - "/v1/Credentials/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The Twilio-provided string that uniquely identifies the Credential resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Credentials for push notifications channels", - "get": { - "description": "", - "parameters": [ - { - "description": "The Twilio-provided string that uniquely identifies the Credential resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.credential" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The Twilio-provided string that uniquely identifies the Credential resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiKey": { - "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", - "type": "string" - }, - "Certificate": { - "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "PrivateKey": { - "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", - "type": "string" - }, - "Sandbox": { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "type": "boolean" - }, - "Secret": { - "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.credential" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "instance" - }, - "/v1/Services": { - "description": "Top level scope for all chat resources", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "services": { - "items": { - "$ref": "#/components/schemas/chat.v1.service" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FriendlyName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels": { - "description": "Channels represent chat rooms", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.", - "in": "query", - "name": "Type", - "schema": { - "items": { - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.channel" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "A valid JSON string that contains application-specific data.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "type": "string" - }, - "Type": { - "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`.", - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "UniqueName": { - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { - "description": "Pending invitations to users to become channel members", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resources to read belong to.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", - "in": "query", - "name": "Identity", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "invites": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.channel.invite" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new resource belongs to.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Identity": { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", - "type": "string" - }, - "RoleSid": { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new member.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "Identity" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.invite" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to delete belongs to.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Invite resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Pending invitations to users to become channel members", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to fetch belongs to.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Invite resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.invite" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members": { - "description": "Users joined to specific channels", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the members to read belong to. Can be the Channel resource's `sid` or `unique_name` value.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", - "in": "query", - "name": "Identity", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.channel.member" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new member belongs to. Can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Identity": { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", - "type": "string" - }, - "RoleSid": { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "Identity" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.member" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Member resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Users joined to specific channels", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Member resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.member" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to update belongs to. Can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Member resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "LastConsumedMessageIndex": { - "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels).", - "nullable": true, - "type": "integer" - }, - "RoleSid": { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.member" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages": { - "description": "Individual chat messages", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to read belongs to. Can be the Channel's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.", - "in": "query", - "name": "Order", - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "messages": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.channel.message" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new resource belongs to. Can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "A valid JSON string that contains application-specific data.", - "type": "string" - }, - "Body": { - "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", - "type": "string" - }, - "From": { - "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.", - "type": "string" - } - }, - "required": [ - "Body" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.message" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to delete belongs to. Can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Message resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Individual chat messages", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to fetch belongs to. Can be the Channel's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Message resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.message" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Message resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "A valid JSON string that contains application-specific data.", - "type": "string" - }, - "Body": { - "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel.message" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Channels/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Channel resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Channels represent chat rooms", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Channel resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Channel resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "A valid JSON string that contains application-specific data.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.channel" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Roles": { - "description": "Roles determining user or member permissions", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "roles": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.role" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "type": "string" - }, - "Permission": { - "description": "A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Type": { - "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) roles.", - "enum": [ - "channel", - "deployment" - ], - "type": "string" - } - }, - "required": [ - "FriendlyName", - "Type", - "Permission" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.role" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Roles/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Role resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Roles determining user or member permissions", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Role resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.role" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Role resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Permission": { - "description": "A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Permission" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.role" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Users": { - "description": "Unique chat users within a chat service", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "users": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.user" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "A valid JSON string that contains application-specific data.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the new resource. This value is often used for display purposes.", - "type": "string" - }, - "Identity": { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is often a username or email address. See the Identity documentation for more details.", - "type": "string" - }, - "RoleSid": { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new User.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "Identity" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.user" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Users/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the User resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Unique chat users within a chat service", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the User resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.user" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the User resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "A valid JSON string that contains application-specific data.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It is often used for display purposes.", - "type": "string" - }, - "RoleSid": { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service.user" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { - "description": "TODO: Resource-level docs", - "get": { - "description": "List all Channels for a given User.", - "parameters": [ - { - "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [User](https://www.twilio.com/docs/api/chat/rest/users) to read the User Channel resources from.", - "in": "path", - "name": "UserSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/chat.v1.service.user.user_channel" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "channel_sid", - "status" - ], - "x-path-type": "list" - }, - "/v1/Services/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The Twilio-provided string that uniquely identifies the Service resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Top level scope for all chat resources", - "get": { - "description": "", - "parameters": [ - { - "description": "The Twilio-provided string that uniquely identifies the Service resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The Twilio-provided string that uniquely identifies the Service resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ConsumptionReportInterval": { - "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.", - "type": "integer" - }, - "DefaultChannelCreatorRoleSid": { - "description": "The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "DefaultChannelRoleSid": { - "description": "The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "DefaultServiceRoleSid": { - "description": "The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "Limits.ChannelMembers": { - "description": "The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.", - "type": "integer" - }, - "Limits.UserChannels": { - "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.", - "type": "integer" - }, - "Notifications.AddedToChannel.Enabled": { - "description": "Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.", - "type": "boolean" - }, - "Notifications.AddedToChannel.Template": { - "description": "The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", - "type": "string" - }, - "Notifications.InvitedToChannel.Enabled": { - "description": "Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.", - "type": "boolean" - }, - "Notifications.InvitedToChannel.Template": { - "description": "The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", - "type": "string" - }, - "Notifications.NewMessage.Enabled": { - "description": "Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.", - "type": "boolean" - }, - "Notifications.NewMessage.Template": { - "description": "The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", - "type": "string" - }, - "Notifications.RemovedFromChannel.Enabled": { - "description": "Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.", - "type": "boolean" - }, - "Notifications.RemovedFromChannel.Template": { - "description": "The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", - "type": "string" - }, - "PostWebhookUrl": { - "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", - "format": "uri", - "type": "string" - }, - "PreWebhookUrl": { - "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", - "format": "uri", - "type": "string" - }, - "ReachabilityEnabled": { - "description": "Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.", - "type": "boolean" - }, - "ReadStatusEnabled": { - "description": "Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.", - "type": "boolean" - }, - "TypingIndicatorTimeout": { - "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.", - "type": "integer" - }, - "WebhookFilters": { - "description": "The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "items": { - "type": "string" - }, - "type": "array" - }, - "WebhookMethod": { - "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelAdd.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_channel_add.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelAdd.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelAdded.Method": { - "description": "The URL of the webhook to call in response to the `on_channel_added` event`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelAdded.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelDestroy.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelDestroy.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelDestroyed.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelDestroyed.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelUpdate.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_channel_update.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelUpdate.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelUpdated.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelUpdated.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberAdd.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_member_add.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberAdd.Url": { - "description": "The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberAdded.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberAdded.Url": { - "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberRemove.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_member_remove.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberRemove.Url": { - "description": "The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberRemoved.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_member_removed.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberRemoved.Url": { - "description": "The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageRemove.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_message_remove.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageRemove.Url": { - "description": "The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageRemoved.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_message_removed.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageRemoved.Url": { - "description": "The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageSend.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_message_send.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageSend.Url": { - "description": "The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageSent.Method": { - "description": "The URL of the webhook to call in response to the `on_message_sent` event`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageSent.Url": { - "description": "The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageUpdate.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_message_update.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageUpdate.Url": { - "description": "The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageUpdated.Method": { - "description": "The HTTP method to use when calling the `webhooks.on_message_updated.url`.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageUpdated.Url": { - "description": "The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/chat.v1.service" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://chat.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Chat", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { "/v2/Credentials": { "description": "Credentials for push notifications channels", "get": { diff --git a/spec/json/twilio_conversations.json b/spec/json/twilio_conversations_v1.json similarity index 99% rename from spec/json/twilio_conversations.json rename to spec/json/twilio_conversations_v1.json index 97ded778..f7431d3a 100644 --- a/spec/json/twilio_conversations.json +++ b/spec/json/twilio_conversations_v1.json @@ -1111,7 +1111,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Conversations", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_events.json b/spec/json/twilio_events_v1.json similarity index 99% rename from spec/json/twilio_events.json rename to spec/json/twilio_events_v1.json index be39955a..d15bdc7c 100644 --- a/spec/json/twilio_events.json +++ b/spec/json/twilio_events_v1.json @@ -227,7 +227,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Events", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_fax.json b/spec/json/twilio_fax_v1.json similarity index 99% rename from spec/json/twilio_fax.json rename to spec/json/twilio_fax_v1.json index 17f1ee15..52fba4e2 100644 --- a/spec/json/twilio_fax.json +++ b/spec/json/twilio_fax_v1.json @@ -154,7 +154,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Fax", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_flex.json b/spec/json/twilio_flex_v1.json similarity index 99% rename from spec/json/twilio_flex.json rename to spec/json/twilio_flex_v1.json index 159b9353..4ff6f88b 100644 --- a/spec/json/twilio_flex.json +++ b/spec/json/twilio_flex_v1.json @@ -343,7 +343,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Flex", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_insights.json b/spec/json/twilio_insights_v1.json similarity index 99% rename from spec/json/twilio_insights.json rename to spec/json/twilio_insights_v1.json index b73f2510..d9dc0b91 100644 --- a/spec/json/twilio_insights.json +++ b/spec/json/twilio_insights_v1.json @@ -518,7 +518,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Insights", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio.json b/spec/json/twilio_ip_messaging_v1.json similarity index 59% rename from spec/json/twilio_studio.json rename to spec/json/twilio_ip_messaging_v1.json index f43f2f3a..70e9fbef 100644 --- a/spec/json/twilio_studio.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -1,7 +1,7 @@ { "components": { "schemas": { - "studio.v1.flow": { + "ip_messaging.v1.credential": { "properties": { "account_sid": { "maxLength": 34, @@ -20,33 +20,31 @@ "friendly_name": { "type": "string" }, - "links": { - "type": "object" + "sandbox": { + "type": "string" }, "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" }, - "status": { + "type": { "enum": [ - "draft", - "published" + "gcm", + "apn", + "fcm" ], "type": "string" }, "url": { "format": "uri", "type": "string" - }, - "version": { - "type": "integer" } }, "type": "object" }, - "studio.v1.flow.engagement": { + "ip_messaging.v1.service": { "properties": { "account_sid": { "maxLength": 34, @@ -54,17 +52,8 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "contact_channel_address": { - "type": "string" - }, - "contact_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FC[0-9a-fA-F]{32}$", - "type": "string" - }, - "context": { - "type": "object" + "consumption_report_interval": { + "type": "integer" }, "date_created": { "format": "date-time", @@ -74,66 +63,77 @@ "format": "date-time", "type": "string" }, - "flow_sid": { + "default_channel_creator_role_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" }, - "links": { - "type": "object" - }, - "sid": { + "default_channel_role_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "active", - "ended" - ], + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v1.flow.engagement.engagement_context": { - "properties": { - "account_sid": { + "default_service_role_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "friendly_name": { "type": "string" }, - "context": { + "limits": { "type": "object" }, - "engagement_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "links": { + "type": "object" + }, + "notifications": { + "type": "object" + }, + "post_webhook_url": { + "type": "string" + }, + "pre_webhook_url": { "type": "string" }, - "flow_sid": { + "reachability_enabled": { + "type": "boolean" + }, + "read_status_enabled": { + "type": "boolean" + }, + "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, + "typing_indicator_timeout": { + "type": "integer" + }, "url": { "format": "uri", "type": "string" + }, + "webhook_filters": { + "items": { + "type": "string" + }, + "type": "array" + }, + "webhook_method": { + "type": "string" + }, + "webhooks": { + "type": "object" } }, "type": "object" }, - "studio.v1.flow.engagement.step": { + "ip_messaging.v1.service.channel": { "properties": { "account_sid": { "maxLength": 34, @@ -141,8 +141,11 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" + "attributes": { + "type": "string" + }, + "created_by": { + "type": "string" }, "date_created": { "format": "date-time", @@ -152,34 +155,38 @@ "format": "date-time", "type": "string" }, - "engagement_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" - }, - "flow_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "friendly_name": { "type": "string" }, "links": { "type": "object" }, - "name": { + "members_count": { + "type": "integer" + }, + "messages_count": { + "type": "integer" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, - "transitioned_from": { + "type": { + "enum": [ + "public", + "private" + ], "type": "string" }, - "transitioned_to": { + "unique_name": { "type": "string" }, "url": { @@ -189,7 +196,7 @@ }, "type": "object" }, - "studio.v1.flow.engagement.step.step_context": { + "ip_messaging.v1.service.channel.invite": { "properties": { "account_sid": { "maxLength": 34, @@ -197,25 +204,42 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "identity": { + "type": "string" }, - "engagement_sid": { + "role_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" }, - "flow_sid": { + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "step_sid": { + "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^IN[0-9a-fA-F]{32}$", "type": "string" }, "url": { @@ -225,7 +249,7 @@ }, "type": "object" }, - "studio.v1.flow.execution": { + "ip_messaging.v1.service.channel.member": { "properties": { "account_sid": { "maxLength": 34, @@ -233,18 +257,12 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "contact_channel_address": { - "type": "string" - }, - "contact_sid": { + "channel_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FC[0-9a-fA-F]{32}$", + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" - }, "date_created": { "format": "date-time", "type": "string" @@ -253,56 +271,33 @@ "format": "date-time", "type": "string" }, - "flow_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "identity": { "type": "string" }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" + "last_consumed_message_index": { + "nullable": true, + "type": "integer" }, - "status": { - "enum": [ - "active", - "ended" - ], + "last_consumption_timestamp": { + "format": "date-time", "type": "string" }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v1.flow.execution.execution_context": { - "properties": { - "account_sid": { + "role_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" - }, - "execution_sid": { + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "flow_sid": { + "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" }, "url": { @@ -312,7 +307,7 @@ }, "type": "object" }, - "studio.v1.flow.execution.execution_step": { + "ip_messaging.v1.service.channel.message": { "properties": { "account_sid": { "maxLength": 34, @@ -320,91 +315,61 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "execution_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" - }, - "flow_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "attributes": { "type": "string" }, - "links": { - "type": "object" - }, - "name": { + "body": { "type": "string" }, - "sid": { + "channel_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, - "transitioned_from": { + "date_created": { + "format": "date-time", "type": "string" }, - "transitioned_to": { + "date_updated": { + "format": "date-time", "type": "string" }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v1.flow.execution.execution_step.execution_step_context": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "from": { "type": "string" }, - "context": { - "type": "object" + "index": { + "type": "integer" }, - "execution_sid": { + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "flow_sid": { + "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IM[0-9a-fA-F]{32}$", "type": "string" }, - "step_sid": { + "to": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, "url": { "format": "uri", "type": "string" + }, + "was_edited": { + "type": "boolean" } }, "type": "object" }, - "studio.v2.flow": { + "ip_messaging.v1.service.role": { "properties": { "account_sid": { "maxLength": 34, @@ -412,9 +377,6 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "commit_message": { - "type": "string" - }, "date_created": { "format": "date-time", "type": "string" @@ -423,58 +385,42 @@ "format": "date-time", "type": "string" }, - "definition": { - "type": "object" + "friendly_name": { + "type": "string" }, - "errors": { + "permissions": { "items": { - "type": "object" + "type": "string" }, "type": "array" }, - "friendly_name": { + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "links": { - "type": "object" - }, - "revision": { - "type": "integer" - }, "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" }, - "status": { + "type": { "enum": [ - "draft", - "published" + "channel", + "deployment" ], "type": "string" }, "url": { "format": "uri", "type": "string" - }, - "valid": { - "type": "boolean" - }, - "warnings": { - "items": { - "type": "object" - }, - "type": "array" - }, - "webhook_url": { - "format": "uri", - "type": "string" } }, "type": "object" }, - "studio.v2.flow.execution": { + "ip_messaging.v1.service.user": { "properties": { "account_sid": { "maxLength": 34, @@ -482,12 +428,9 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "contact_channel_address": { + "attributes": { "type": "string" }, - "context": { - "type": "object" - }, "date_created": { "format": "date-time", "type": "string" @@ -496,56 +439,40 @@ "format": "date-time", "type": "string" }, - "flow_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "friendly_name": { "type": "string" }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "identity": { "type": "string" }, - "status": { - "enum": [ - "active", - "ended" - ], - "type": "string" + "is_notifiable": { + "type": "boolean" }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v2.flow.execution.execution_context": { - "properties": { - "account_sid": { + "is_online": { + "type": "boolean" + }, + "joined_channels_count": { + "type": "integer" + }, + "links": { + "type": "object" + }, + "role_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" - }, - "execution_sid": { + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "flow_sid": { + "sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^US[0-9a-fA-F]{32}$", "type": "string" }, "url": { @@ -555,7 +482,7 @@ }, "type": "object" }, - "studio.v2.flow.execution.execution_step": { + "ip_messaging.v1.service.user.user_channel": { "properties": { "account_sid": { "maxLength": 34, @@ -563,172 +490,42 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "context": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "execution_sid": { + "channel_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, - "flow_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" + "last_consumed_message_index": { + "nullable": true, + "type": "integer" }, "links": { "type": "object" }, - "name": { - "type": "string" - }, - "sid": { + "member_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" }, - "transitioned_from": { + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "transitioned_to": { + "status": { + "enum": [ + "joined", + "invited", + "not_participating" + ], "type": "string" }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v2.flow.execution.execution_step.execution_step_context": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "context": { - "type": "object" - }, - "execution_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" - }, - "flow_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - }, - "step_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v2.flow.flow_revision": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "commit_message": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "definition": { - "type": "object" - }, - "errors": { - "items": { - "type": "object" - }, - "type": "array" - }, - "friendly_name": { - "type": "string" - }, - "revision": { - "type": "integer" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "draft", - "published" - ], - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "valid": { - "type": "boolean" - } - }, - "type": "object" - }, - "studio.v2.flow.test_user": { - "properties": { - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - }, - "test_users": { - "items": { - "type": "string" - }, - "type": "array" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "studio.v2.flow_validate": { - "properties": { - "valid": { - "type": "boolean" + "unread_messages_count": { + "nullable": true, + "type": "integer" } }, "type": "object" @@ -753,116 +550,16 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Studio", - "version": "1.3.0" + "title": "Twilio - Ip_messaging", + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { - "/v1/Flows": { - "description": "Studio flows", - "get": { - "description": "Retrieve a list of all Flows.", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "flows": { - "items": { - "$ref": "#/components/schemas/studio.v1.flow" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status", - "version" - ], - "x-path-type": "list" - }, - "/v1/Flows/{FlowSid}/Engagements": { - "description": "[DEPRECATED] Excecutions of Studio flows", + "/v1/Credentials": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve a list of all Engagements for the Flow.", + "description": "", "parameters": [ - { - "description": "The SID of the Flow to read Engagements from.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -880,9 +577,9 @@ "application/json": { "schema": { "properties": { - "engagements": { + "credentials": { "items": { - "$ref": "#/components/schemas/studio.v1.flow.engagement" + "$ref": "#/components/schemas/ip_messaging.v1.credential" }, "type": "array" }, @@ -934,42 +631,48 @@ ] }, "post": { - "description": "Triggers a new Engagement for the Flow", - "parameters": [ - { - "description": "The SID of the Flow.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], + "description": "", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "From": { - "description": "The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`", + "ApiKey": { + "description": "", + "type": "string" + }, + "Certificate": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "PrivateKey": { + "description": "", "type": "string" }, - "Parameters": { - "description": "A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.", - "type": "object" + "Sandbox": { + "description": "", + "type": "boolean" + }, + "Secret": { + "description": "", + "type": "string" }, - "To": { - "description": "The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.", + "Type": { + "description": "", + "enum": [ + "gcm", + "apn", + "fcm" + ], "type": "string" } }, "required": [ - "To", - "From" + "Type" ], "type": "object" } @@ -981,7 +684,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.engagement" + "$ref": "#/components/schemas/ip_messaging.v1.credential" } } }, @@ -999,43 +702,60 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "contact_sid", - "status", - "date_created" + "friendly_name", + "type" ], "x-path-type": "list" }, - "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context": { - "description": "[DEPRECATED] JSON context for engagements", - "get": { - "description": "Retrieve the most recent context for an Engagement.", + "/v1/Credentials/{Sid}": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the Flow.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ { - "description": "The SID of the Engagement.", + "description": "", "in": "path", - "name": "EngagementSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } } @@ -1045,7 +765,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.engagement.engagement_context" + "$ref": "#/components/schemas/ip_messaging.v1.credential" } } }, @@ -1061,45 +781,95 @@ "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "context" - ], - "x-path-type": "instance" - }, - "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps": { - "description": "Steps within a Studio flow", - "get": { - "description": "Retrieve a list of all Steps for an Engagement.", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Step to read.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the Engagement with the Step to read.", - "in": "path", - "name": "EngagementSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "", + "type": "string" + }, + "Certificate": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "PrivateKey": { + "description": "", + "type": "string" + }, + "Sandbox": { + "description": "", + "type": "boolean" + }, + "Secret": { + "description": "", + "type": "string" + } + }, + "type": "object" + } } - }, + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ip_messaging.v1.credential" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://ip-messaging.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "type" + ], + "x-path-type": "instance" + }, + "/v1/Services": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -1147,9 +917,9 @@ }, "type": "object" }, - "steps": { + "services": { "items": { - "$ref": "#/components/schemas/studio.v1.flow.engagement.step" + "$ref": "#/components/schemas/ip_messaging.v1.service" }, "type": "array" } @@ -1170,71 +940,36 @@ "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "name", - "transitioned_from", - "transitioned_to" - ], - "x-path-type": "list" - }, - "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}": { - "description": "Steps within a Studio flow", - "get": { - "description": "Retrieve a Step.", - "parameters": [ - { - "description": "The SID of the Flow with the Step to fetch.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Engagement with the Step to fetch.", - "in": "path", - "name": "EngagementSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Step resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", - "type": "string" + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.engagement.step" + "$ref": "#/components/schemas/ip_messaging.v1.service" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1248,56 +983,56 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "name", - "transitioned_from", - "transitioned_to" + "friendly_name", + "date_created" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context": { - "description": "JSON context for individual steps", + "/v1/Services/{ServiceSid}/Channels": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve the context for an Engagement Step.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Step to fetch.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Engagement with the Step to fetch.", - "in": "path", - "name": "EngagementSid", - "required": true, + "description": "", + "in": "query", + "name": "Type", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" + "items": { + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "type": "array" } }, { - "description": "The SID of the Step to fetch", - "in": "path", - "name": "StepSid", - "required": true, + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } } ], @@ -1306,7 +1041,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.engagement.step.step_context" + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" } } }, @@ -1322,98 +1095,63 @@ "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "context" - ], - "x-path-type": "instance" - }, - "/v1/Flows/{FlowSid}/Engagements/{Sid}": { - "delete": { - "description": "Delete this Engagement and all Steps relating to it.", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the Flow to delete Engagements from.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Engagement resource to delete.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } } ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "[DEPRECATED] Excecutions of Studio flows", - "get": { - "description": "Retrieve an Engagement", - "parameters": [ - { - "description": "The SID of the Flow.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Engagement resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "Type": { + "description": "", + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.engagement" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1427,50 +1165,51 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "contact_sid", - "status", - "date_created" + "unique_name", + "friendly_name" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/v1/Flows/{FlowSid}/Executions": { - "description": "Executions of Studio flows", + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve a list of all Executions for the Flow.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resources to read.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", - "in": "query", - "name": "DateCreatedFrom", + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, "schema": { - "format": "date-time", "type": "string" } }, { - "description": "Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", + "description": "", "in": "query", - "name": "DateCreatedTo", + "name": "Identity", "schema": { - "format": "date-time", - "type": "string" + "items": { + "type": "string" + }, + "type": "array" } }, { @@ -1490,9 +1229,9 @@ "application/json": { "schema": { "properties": { - "executions": { + "invites": { "items": { - "$ref": "#/components/schemas/studio.v1.flow.execution" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" }, "type": "array" }, @@ -1544,17 +1283,26 @@ ] }, "post": { - "description": "Triggers a new Execution for the Flow", + "description": "", "parameters": [ { - "description": "The SID of the Excecution's Flow.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { "type": "string" } } @@ -1564,22 +1312,20 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "From": { - "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", + "Identity": { + "description": "", "type": "string" }, - "Parameters": { - "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", - "type": "object" - }, - "To": { - "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", + "RoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } }, "required": [ - "To", - "From" + "Identity" ], "type": "object" } @@ -1591,7 +1337,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.execution" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" } } }, @@ -1609,43 +1355,102 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "contact_sid", - "status", + "identity", "date_created" ], "x-path-type": "list" }, - "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context": { - "description": "JSON context for executions", + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve the most recent context for an Execution.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution context to fetch.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { "type": "string" } }, { - "description": "The SID of the Execution context to fetch.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IN[0-9a-fA-F]{32}$", "type": "string" } } @@ -1655,7 +1460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.execution.execution_context" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" } } }, @@ -1673,43 +1478,53 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ - "context" + "sid", + "identity", + "date_created" ], "x-path-type": "instance" }, - "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { - "description": "Individual steps within an execution", + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve a list of all Steps for an Execution.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Steps to read.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution with the Steps to read.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "ChannelSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", "type": "string" } }, + { + "description": "", + "in": "query", + "name": "Identity", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -1727,6 +1542,12 @@ "application/json": { "schema": { "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "type": "array" + }, "meta": { "properties": { "first_page_url": { @@ -1756,12 +1577,6 @@ } }, "type": "object" - }, - "steps": { - "items": { - "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" - }, - "type": "array" } }, "type": "object" @@ -1780,70 +1595,66 @@ "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "name", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { - "description": "Individual steps within an execution", - "get": { - "description": "Retrieve a Step.", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Step to fetch.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Execution resource with the Step to fetch.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the ExecutionStep resource to fetch.", + "description": "", "in": "path", - "name": "Sid", + "name": "ChannelSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "", + "type": "string" + }, + "RoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1857,68 +1668,57 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "name", + "identity", "date_created" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { - "description": "JSON context for an individual step within an execution", - "get": { - "description": "Retrieve the context for an Execution Step.", + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Step to fetch.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution resource with the Step to fetch.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "ChannelSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Step to fetch.", + "description": "", "in": "path", - "name": "StepSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -1930,84 +1730,40 @@ "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "context" - ], - "x-path-type": "instance" - }, - "/v1/Flows/{FlowSid}/Executions/{Sid}": { - "delete": { - "description": "Delete the Execution and all Steps relating to it.", + "description": "TODO: Resource-level docs", + "get": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resources to delete.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Executions of Studio flows", - "get": { - "description": "Retrieve an Execution", - "parameters": [ - { - "description": "The SID of the Flow with the Execution resource to fetch", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ChannelSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution resource to fetch.", + "description": "", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" } } @@ -2017,7 +1773,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.execution" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } } }, @@ -2034,29 +1790,38 @@ ] }, "post": { - "description": "Update the status of an Execution to `ended`.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resources to update.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution resource to update.", + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" } } @@ -2066,18 +1831,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "Status": { - "description": "The status of the Execution. Can only be `ended`.", - "enum": [ - "active", - "ended" - ], + "LastConsumedMessageIndex": { + "description": "", + "nullable": true, + "type": "integer" + }, + "RoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } }, - "required": [ - "Status" - ], "type": "object" } } @@ -2088,7 +1854,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v1.flow.execution" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } } }, @@ -2106,104 +1872,57 @@ }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "contact_sid", - "status", + "identity", "date_created" ], "x-path-type": "instance" }, - "/v1/Flows/{Sid}": { - "delete": { - "description": "Delete a specific Flow.", + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", "parameters": [ { - "description": "The SID of the Flow resource to delete.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Studio flows", - "get": { - "description": "Retrieve a specific Flow.", - "parameters": [ + }, { - "description": "The SID of the Flow resource to fetch.", + "description": "", "in": "path", - "name": "Sid", + "name": "ChannelSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/studio.v1.flow" - } - } - }, - "description": "OK" - } - }, - "security": [ + }, { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status", - "version" - ], - "x-path-type": "instance" - }, - "/v2/Flows": { - "description": "Studio flows", - "get": { - "description": "Retrieve a list of all Flows.", - "parameters": [ + "description": "", + "in": "query", + "name": "Order", + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -2221,9 +1940,9 @@ "application/json": { "schema": { "properties": { - "flows": { + "messages": { "items": { - "$ref": "#/components/schemas/studio.v2.flow" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" }, "type": "array" }, @@ -2271,41 +1990,57 @@ } ], "tags": [ - "Beta" + "GA" ] }, "post": { - "description": "Create a Flow.", + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "CommitMessage": { - "description": "Description on change made in the revision.", + "Attributes": { + "description": "", "type": "string" }, - "Definition": { - "description": "JSON representation of flow definition.", - "type": "object" - }, - "FriendlyName": { - "description": "The string that you assigned to describe the Flow.", + "Body": { + "description": "", "type": "string" }, - "Status": { - "description": "The status of the Flow. Can be: `draft` or `published`.", - "enum": [ - "draft", - "published" - ], + "From": { + "description": "", "type": "string" } }, "required": [ - "FriendlyName", - "Status", - "Definition" + "Body" ], "type": "object" } @@ -2317,7 +2052,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" } } }, @@ -2326,61 +2061,197 @@ }, "security": [ { - "accountSid_authToken": [] + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://ip-messaging.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "from", + "to", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IM[0-9a-fA-F]{32}$", + "type": "string" + } } ], - "tags": [ - "Beta" - ] - }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status", - "revision" - ], - "x-path-type": "list" - }, - "/v2/Flows/Validate": { - "description": "TODO: Resource-level docs", - "post": { - "description": "", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "CommitMessage": { + "Attributes": { "description": "", "type": "string" }, - "Definition": { + "Body": { "description": "", - "type": "object" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "Status": { - "description": "", - "enum": [ - "draft", - "published" - ], "type": "string" } }, - "required": [ - "FriendlyName", - "Status", - "Definition" - ], "type": "object" } } @@ -2391,7 +2262,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow_validate" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" } } }, @@ -2404,113 +2275,51 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ - "valid" + "sid", + "from", + "to", + "date_created" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/v2/Flows/{FlowSid}/Executions": { - "description": "Executions of Studio flows", - "get": { - "description": "Retrieve a list of all Executions for the Flow.", + "/v1/Services/{ServiceSid}/Channels/{Sid}": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resources to read.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", - "in": "query", - "name": "DateCreatedFrom", - "schema": { - "format": "date-time", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", - "in": "query", - "name": "DateCreatedTo", + "description": "", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "format": "date-time", "type": "string" } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "executions": { - "items": { - "$ref": "#/components/schemas/studio.v2.flow.execution" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -2519,62 +2328,45 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "post": { - "description": "Triggers a new Execution for the Flow", + "description": "TODO: Resource-level docs", + "get": { + "description": "", "parameters": [ { - "description": "The SID of the Excecution's Flow.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "From": { - "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", - "type": "string" - }, - "Parameters": { - "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", - "type": "object" - }, - "To": { - "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", - "type": "string" - } - }, - "required": [ - "To", - "From" - ], - "type": "object" - } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.execution" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -2583,57 +2375,63 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "status", - "date_created" - ], - "x-path-type": "list" - }, - "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context": { - "description": "JSON context for executions", - "get": { - "description": "Retrieve the most recent context for an Execution.", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution context to fetch.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution context to fetch.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "Sid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.execution.execution_context" + "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } } }, @@ -2646,45 +2444,35 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ - "context" + "sid", + "unique_name", + "friendly_name" ], "x-path-type": "instance" }, - "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { - "description": "Individual steps within an execution", + "/v1/Services/{ServiceSid}/Roles": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve a list of all Steps for an Execution.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Steps to read.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Execution with the Steps to read.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, @@ -2735,18 +2523,90 @@ }, "type": "object" }, - "steps": { + "roles": { "items": { - "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" + "$ref": "#/components/schemas/ip_messaging.v1.service.role" }, "type": "array" } }, - "type": "object" + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "", + "type": "string" + }, + "Permission": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + }, + "Type": { + "description": "", + "enum": [ + "channel", + "deployment" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Type", + "Permission" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ip_messaging.v1.service.role" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -2755,73 +2615,53 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "name", - "date_created" + "friendly_name", + "type" ], "x-path-type": "list" }, - "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { - "description": "Individual steps within an execution", - "get": { - "description": "Retrieve a Step.", + "/v1/Services/{ServiceSid}/Roles/{Sid}": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Step to fetch.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Execution resource with the Step to fetch.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the ExecutionStep resource to fetch.", + "description": "", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -2830,59 +2670,34 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "name", - "date_created" - ], - "x-path-type": "instance" - }, - "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { - "description": "JSON context for an individual step within an execution", + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve the context for an Execution Step.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Step to fetch.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Execution resource with the Step to fetch.", + "description": "", "in": "path", - "name": "ExecutionSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Step to fetch.", + "description": "", "in": "path", - "name": "StepSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FT[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } } @@ -2892,7 +2707,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context" + "$ref": "#/components/schemas/ip_messaging.v1.service.role" } } }, @@ -2905,51 +2720,68 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "context" - ], - "x-path-type": "instance" - }, - "/v2/Flows/{FlowSid}/Executions/{Sid}": { - "delete": { - "description": "Delete the Execution and all Steps relating to it.", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resources to delete.", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution resource to delete.", + "description": "", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Permission": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Permission" + ], + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ip_messaging.v1.service.role" + } + } + }, + "description": "OK" } }, "security": [ @@ -2958,35 +2790,46 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "description": "Executions of Studio flows", + "servers": [ + { + "url": "https://ip-messaging.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "type" + ], + "x-path-type": "instance" + }, + "/v1/Services/{ServiceSid}/Users": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve an Execution", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resource to fetch", + "description": "", "in": "path", - "name": "FlowSid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Execution resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } } ], @@ -2995,7 +2838,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.execution" + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "users": { + "items": { + "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "type": "array" + } + }, + "type": "object" } } }, @@ -3008,33 +2889,21 @@ } ], "tags": [ - "Beta" + "GA" ] }, "post": { - "description": "Update the status of an Execution to `ended`.", + "description": "", "parameters": [ { - "description": "The SID of the Flow with the Execution resources to update.", - "in": "path", - "name": "FlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Execution resource to update.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FN[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } } @@ -3044,17 +2913,28 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "Status": { - "description": "The status of the Execution. Can only be `ended`.", - "enum": [ - "active", - "ended" - ], + "Attributes": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "Identity": { + "description": "", + "type": "string" + }, + "RoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } }, "required": [ - "Status" + "Identity" ], "type": "object" } @@ -3062,15 +2942,15 @@ } }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.execution" + "$ref": "#/components/schemas/ip_messaging.v1.service.user" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -3079,34 +2959,43 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", - "status", + "friendly_name", "date_created" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/v2/Flows/{Sid}": { + "/v1/Services/{ServiceSid}/Users/{Sid}": { "delete": { - "description": "Delete a specific Flow.", + "description": "", "parameters": [ { - "description": "The SID of the Flow resource to delete.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { "type": "string" } } @@ -3122,22 +3011,31 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "description": "Studio flows", + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve a specific Flow.", + "description": "", "parameters": [ { - "description": "The SID of the Flow resource to fetch.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { "type": "string" } } @@ -3147,7 +3045,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow" + "$ref": "#/components/schemas/ip_messaging.v1.service.user" } } }, @@ -3160,21 +3058,30 @@ } ], "tags": [ - "Beta" + "GA" ] }, "post": { - "description": "Update a Flow.", + "description": "", "parameters": [ { - "description": "The SID of the Flow resource to fetch.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { "type": "string" } } @@ -3184,30 +3091,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "CommitMessage": { - "description": "Description on change made in the revision.", + "Attributes": { + "description": "", "type": "string" }, - "Definition": { - "description": "JSON representation of flow definition.", - "type": "object" - }, "FriendlyName": { - "description": "The string that you assigned to describe the Flow.", + "description": "", "type": "string" }, - "Status": { - "description": "The status of the Flow. Can be: `draft` or `published`.", - "enum": [ - "draft", - "published" - ], + "RoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } }, - "required": [ - "Status" - ], "type": "object" } } @@ -3218,7 +3117,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow" + "$ref": "#/components/schemas/ip_messaging.v1.service.user" } } }, @@ -3231,36 +3130,44 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ "sid", "friendly_name", - "status", - "revision" + "date_created" ], "x-path-type": "instance" }, - "/v2/Flows/{Sid}/Revisions": { - "description": "Studio flows revisions", + "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { + "description": "TODO: Resource-level docs", "get": { - "description": "Retrieve a list of all Flows revisions.", + "description": "", "parameters": [ { - "description": "The SID of the Flow resource to fetch.", + "description": "", "in": "path", - "name": "Sid", + "name": "ServiceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "UserSid", + "required": true, + "schema": { "type": "string" } }, @@ -3281,6 +3188,12 @@ "application/json": { "schema": { "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/ip_messaging.v1.service.user.user_channel" + }, + "type": "array" + }, "meta": { "properties": { "first_page_url": { @@ -3310,12 +3223,6 @@ } }, "type": "object" - }, - "revisions": { - "items": { - "$ref": "#/components/schemas/studio.v2.flow.flow_revision" - }, - "type": "array" } }, "type": "object" @@ -3331,59 +3238,40 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ - "sid", - "friendly_name", - "status", - "revision" + "channel_sid", + "status" ], "x-path-type": "list" }, - "/v2/Flows/{Sid}/Revisions/{Revision}": { - "description": "Studio flows revisions", - "get": { - "description": "Retrieve a specific Flow revision.", + "/v1/Services/{Sid}": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the Flow resource to fetch.", + "description": "", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Specific Revision number or can be `LatestPublished` and `LatestRevision`.", - "in": "path", - "name": "Revision", - "required": true, - "schema": { + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/studio.v2.flow.flow_revision" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -3392,23 +3280,9 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "servers": [ - { - "url": "https://studio.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status", - "revision" - ], - "x-path-type": "instance" - }, - "/v2/Flows/{Sid}/TestUsers": { "description": "TODO: Resource-level docs", "get": { "description": "", @@ -3421,7 +3295,7 @@ "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } } @@ -3431,7 +3305,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.test_user" + "$ref": "#/components/schemas/ip_messaging.v1.service" } } }, @@ -3444,7 +3318,7 @@ } ], "tags": [ - "Beta" + "GA" ] }, "post": { @@ -3458,7 +3332,7 @@ "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } } @@ -3468,17 +3342,491 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "TestUsers": { + "ConsumptionReportInterval": { + "description": "", + "type": "integer" + }, + "DefaultChannelCreatorRoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultChannelRoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultServiceRoleSid": { + "description": "", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "Limits.ChannelMembers": { + "description": "", + "type": "integer" + }, + "Limits.UserChannels": { + "description": "", + "type": "integer" + }, + "Notifications.AddedToChannel.Enabled": { + "description": "", + "type": "boolean" + }, + "Notifications.AddedToChannel.Template": { + "description": "", + "type": "string" + }, + "Notifications.InvitedToChannel.Enabled": { + "description": "", + "type": "boolean" + }, + "Notifications.InvitedToChannel.Template": { + "description": "", + "type": "string" + }, + "Notifications.NewMessage.Enabled": { + "description": "", + "type": "boolean" + }, + "Notifications.NewMessage.Template": { + "description": "", + "type": "string" + }, + "Notifications.RemovedFromChannel.Enabled": { + "description": "", + "type": "boolean" + }, + "Notifications.RemovedFromChannel.Template": { + "description": "", + "type": "string" + }, + "PostWebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "PreWebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "ReachabilityEnabled": { + "description": "", + "type": "boolean" + }, + "ReadStatusEnabled": { + "description": "", + "type": "boolean" + }, + "TypingIndicatorTimeout": { + "description": "", + "type": "integer" + }, + "WebhookFilters": { "description": "", "items": { "type": "string" }, "type": "array" + }, + "WebhookMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdd.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdd.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelAdded.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdded.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelDestroy.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelDestroy.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelDestroyed.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelDestroyed.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelUpdate.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelUpdate.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelUpdated.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelUpdated.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberAdd.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberAdd.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberAdded.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberAdded.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberRemove.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberRemove.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberRemoved.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberRemoved.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageRemove.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageRemove.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageRemoved.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageRemoved.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageSend.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageSend.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageSent.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageSent.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageUpdate.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageUpdate.Url": { + "description": "", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageUpdated.Method": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageUpdated.Url": { + "description": "", + "format": "uri", + "type": "string" } }, - "required": [ - "TestUsers" - ], "type": "object" } } @@ -3489,7 +3837,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/studio.v2.flow.test_user" + "$ref": "#/components/schemas/ip_messaging.v1.service" } } }, @@ -3502,16 +3850,18 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ { - "url": "https://studio.twilio.com" + "url": "https://ip-messaging.twilio.com" } ], "x-default-output-properties": [ - "test_users" + "sid", + "friendly_name", + "date_created" ], "x-path-type": "instance" } @@ -3520,10 +3870,6 @@ { "description": "This product is Generally Available.", "name": "GA" - }, - { - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution.", - "name": "Beta" } ] } \ No newline at end of file diff --git a/spec/json/twilio_ip_messaging.json b/spec/json/twilio_ip_messaging_v2.json similarity index 56% rename from spec/json/twilio_ip_messaging.json rename to spec/json/twilio_ip_messaging_v2.json index 78264098..e5919c27 100644 --- a/spec/json/twilio_ip_messaging.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -1,7 +1,7 @@ { "components": { "schemas": { - "ip_messaging.v1.credential": { + "ip_messaging.v2.credential": { "properties": { "account_sid": { "maxLength": 34, @@ -44,7 +44,7 @@ }, "type": "object" }, - "ip_messaging.v1.service": { + "ip_messaging.v2.service": { "properties": { "account_sid": { "maxLength": 34, @@ -90,12 +90,21 @@ "links": { "type": "object" }, + "media": { + "type": "object" + }, "notifications": { "type": "object" }, + "post_webhook_retry_count": { + "type": "integer" + }, "post_webhook_url": { "type": "string" }, + "pre_webhook_retry_count": { + "type": "integer" + }, "pre_webhook_url": { "type": "string" }, @@ -126,14 +135,75 @@ }, "webhook_method": { "type": "string" + } + }, + "type": "object" + }, + "ip_messaging.v2.service.binding": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "binding_type": { + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + }, + "credential_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "endpoint": { + "type": "string" + }, + "identity": { + "type": "string" }, - "webhooks": { + "links": { "type": "object" + }, + "message_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" } }, "type": "object" }, - "ip_messaging.v1.service.channel": { + "ip_messaging.v2.service.channel": { "properties": { "account_sid": { "maxLength": 34, @@ -196,7 +266,54 @@ }, "type": "object" }, - "ip_messaging.v1.service.channel.invite": { + "ip_messaging.v2.service.channel.channel_webhook": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "type": "string" + }, + "configuration": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WH[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "ip_messaging.v2.service.channel.invite": { "properties": { "account_sid": { "maxLength": 34, @@ -249,7 +366,7 @@ }, "type": "object" }, - "ip_messaging.v1.service.channel.member": { + "ip_messaging.v2.service.channel.member": { "properties": { "account_sid": { "maxLength": 34, @@ -257,6 +374,9 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, + "attributes": { + "type": "string" + }, "channel_sid": { "maxLength": 34, "minLength": 34, @@ -307,7 +427,7 @@ }, "type": "object" }, - "ip_messaging.v1.service.channel.message": { + "ip_messaging.v2.service.channel.message": { "properties": { "account_sid": { "maxLength": 34, @@ -341,6 +461,12 @@ "index": { "type": "integer" }, + "last_updated_by": { + "type": "string" + }, + "media": { + "type": "object" + }, "service_sid": { "maxLength": 34, "minLength": 34, @@ -359,6 +485,9 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, + "type": { + "type": "string" + }, "url": { "format": "uri", "type": "string" @@ -369,7 +498,7 @@ }, "type": "object" }, - "ip_messaging.v1.service.role": { + "ip_messaging.v2.service.role": { "properties": { "account_sid": { "maxLength": 34, @@ -420,7 +549,7 @@ }, "type": "object" }, - "ip_messaging.v1.service.user": { + "ip_messaging.v2.service.user": { "properties": { "account_sid": { "maxLength": 34, @@ -482,7 +611,7 @@ }, "type": "object" }, - "ip_messaging.v1.service.user.user_channel": { + "ip_messaging.v2.service.user.user_binding": { "properties": { "account_sid": { "maxLength": 34, @@ -490,52 +619,18 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "last_consumed_message_index": { - "nullable": true, - "type": "integer" - }, - "links": { - "type": "object" - }, - "member_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { + "binding_type": { "enum": [ - "joined", - "invited", - "not_participating" + "gcm", + "apn", + "fcm" ], "type": "string" }, - "unread_messages_count": { - "nullable": true, - "type": "integer" - } - }, - "type": "object" - }, - "ip_messaging.v2.credential": { - "properties": { - "account_sid": { + "credential_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" }, "date_created": { @@ -546,34 +641,44 @@ "format": "date-time", "type": "string" }, - "friendly_name": { + "endpoint": { "type": "string" }, - "sandbox": { + "identity": { "type": "string" }, - "sid": { + "message_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "type": { - "enum": [ - "gcm", - "apn", - "fcm" - ], + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BS[0-9a-fA-F]{32}$", "type": "string" }, "url": { "format": "uri", "type": "string" + }, + "user_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^US[0-9a-fA-F]{32}$", + "type": "string" } }, "type": "object" }, - "ip_messaging.v2.service": { + "ip_messaging.v2.service.user.user_channel": { "properties": { "account_sid": { "maxLength": 34, @@ -581,4032 +686,88 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" }, - "consumption_report_interval": { - "type": "integer" - }, - "date_created": { - "format": "date-time", + "channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" }, - "date_updated": { - "format": "date-time", - "type": "string" + "last_consumed_message_index": { + "nullable": true, + "type": "integer" }, - "default_channel_creator_role_sid": { + "links": { + "type": "object" + }, + "member_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", + "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" }, - "default_channel_role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", + "notification_level": { + "enum": [ + "default", + "muted" + ], "type": "string" }, - "default_service_role_sid": { + "service_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "friendly_name": { + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" }, - "limits": { - "type": "object" - }, - "links": { - "type": "object" - }, - "media": { - "type": "object" - }, - "notifications": { - "type": "object" - }, - "post_webhook_retry_count": { - "type": "integer" - }, - "post_webhook_url": { - "type": "string" - }, - "pre_webhook_retry_count": { - "type": "integer" - }, - "pre_webhook_url": { - "type": "string" - }, - "reachability_enabled": { - "type": "boolean" - }, - "read_status_enabled": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "typing_indicator_timeout": { - "type": "integer" - }, - "url": { - "format": "uri", - "type": "string" - }, - "webhook_filters": { - "items": { - "type": "string" - }, - "type": "array" - }, - "webhook_method": { - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.binding": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "binding_type": { + "status": { "enum": [ - "gcm", - "apn", - "fcm" + "joined", + "invited", + "not_participating" ], "type": "string" }, - "credential_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "endpoint": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "links": { - "type": "object" - }, - "message_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.channel": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "created_by": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "members_count": { - "type": "integer" - }, - "messages_count": { + "unread_messages_count": { + "nullable": true, "type": "integer" }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "unique_name": { - "type": "string" - }, "url": { "format": "uri", "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.channel.channel_webhook": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "configuration": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" }, - "sid": { + "user_sid": { "maxLength": 34, "minLength": 34, - "pattern": "^WH[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "format": "uri", + "pattern": "^US[0-9a-fA-F]{32}$", "type": "string" } }, "type": "object" - }, - "ip_messaging.v2.service.channel.invite": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "identity": { - "type": "string" - }, - "role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IN[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.channel.member": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "identity": { - "type": "string" - }, - "last_consumed_message_index": { - "nullable": true, - "type": "integer" - }, - "last_consumption_timestamp": { - "format": "date-time", - "type": "string" - }, - "role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.channel.message": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "body": { - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "from": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "last_updated_by": { - "type": "string" - }, - "media": { - "type": "object" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - }, - "to": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "was_edited": { - "type": "boolean" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.role": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "permissions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": { - "enum": [ - "channel", - "deployment" - ], - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.user": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "attributes": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "is_notifiable": { - "type": "boolean" - }, - "is_online": { - "type": "boolean" - }, - "joined_channels_count": { - "type": "integer" - }, - "links": { - "type": "object" - }, - "role_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.user.user_binding": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "binding_type": { - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - }, - "credential_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "endpoint": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "message_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "user_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "ip_messaging.v2.service.user.user_channel": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - }, - "last_consumed_message_index": { - "nullable": true, - "type": "integer" - }, - "links": { - "type": "object" - }, - "member_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - }, - "notification_level": { - "enum": [ - "default", - "muted" - ], - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "joined", - "invited", - "not_participating" - ], - "type": "string" - }, - "unread_messages_count": { - "nullable": true, - "type": "integer" - }, - "url": { - "format": "uri", - "type": "string" - }, - "user_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - }, - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - } - }, - "info": { - "contact": { - "email": "support@twilio.com", - "name": "Twilio Support", - "url": "https://support.twilio.com" - }, - "description": "This is the public Twilio REST API.", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Ip_messaging", - "version": "1.3.0" - }, - "openapi": "3.0.1", - "paths": { - "/v1/Credentials": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "credentials": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.credential" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiKey": { - "description": "", - "type": "string" - }, - "Certificate": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "PrivateKey": { - "description": "", - "type": "string" - }, - "Sandbox": { - "description": "", - "type": "boolean" - }, - "Secret": { - "description": "", - "type": "string" - }, - "Type": { - "description": "", - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.credential" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "list" - }, - "/v1/Credentials/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.credential" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiKey": { - "description": "", - "type": "string" - }, - "Certificate": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "PrivateKey": { - "description": "", - "type": "string" - }, - "Sandbox": { - "description": "", - "type": "boolean" - }, - "Secret": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.credential" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "instance" - }, - "/v1/Services": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "services": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "", - "type": "string" - } - }, - "required": [ - "FriendlyName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Type", - "schema": { - "items": { - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "Type": { - "description": "", - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Identity", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "invites": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Identity": { - "description": "", - "type": "string" - }, - "RoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "Identity" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Identity", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Identity": { - "description": "", - "type": "string" - }, - "RoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "Identity" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "LastConsumedMessageIndex": { - "description": "", - "nullable": true, - "type": "integer" - }, - "RoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "identity", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Order", - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "messages": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "", - "type": "string" - }, - "Body": { - "description": "", - "type": "string" - }, - "From": { - "description": "", - "type": "string" - } - }, - "required": [ - "Body" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IM[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "", - "type": "string" - }, - "Body": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Channels/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.channel" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Roles": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "roles": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.role" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "", - "type": "string" - }, - "Permission": { - "description": "", - "items": { - "type": "string" - }, - "type": "array" - }, - "Type": { - "description": "", - "enum": [ - "channel", - "deployment" - ], - "type": "string" - } - }, - "required": [ - "FriendlyName", - "Type", - "Permission" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.role" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Roles/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.role" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Permission": { - "description": "", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Permission" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.role" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "type" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Users": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "users": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.user" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "Identity": { - "description": "", - "type": "string" - }, - "RoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "Identity" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.user" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Services/{ServiceSid}/Users/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.user" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Attributes": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "RoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service.user" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" - }, - "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "UserSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/ip_messaging.v1.service.user.user_channel" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "channel_sid", - "status" - ], - "x-path-type": "list" - }, - "/v1/Services/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ConsumptionReportInterval": { - "description": "", - "type": "integer" - }, - "DefaultChannelCreatorRoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "DefaultChannelRoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "DefaultServiceRoleSid": { - "description": "", - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "Limits.ChannelMembers": { - "description": "", - "type": "integer" - }, - "Limits.UserChannels": { - "description": "", - "type": "integer" - }, - "Notifications.AddedToChannel.Enabled": { - "description": "", - "type": "boolean" - }, - "Notifications.AddedToChannel.Template": { - "description": "", - "type": "string" - }, - "Notifications.InvitedToChannel.Enabled": { - "description": "", - "type": "boolean" - }, - "Notifications.InvitedToChannel.Template": { - "description": "", - "type": "string" - }, - "Notifications.NewMessage.Enabled": { - "description": "", - "type": "boolean" - }, - "Notifications.NewMessage.Template": { - "description": "", - "type": "string" - }, - "Notifications.RemovedFromChannel.Enabled": { - "description": "", - "type": "boolean" - }, - "Notifications.RemovedFromChannel.Template": { - "description": "", - "type": "string" - }, - "PostWebhookUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "PreWebhookUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "ReachabilityEnabled": { - "description": "", - "type": "boolean" - }, - "ReadStatusEnabled": { - "description": "", - "type": "boolean" - }, - "TypingIndicatorTimeout": { - "description": "", - "type": "integer" - }, - "WebhookFilters": { - "description": "", - "items": { - "type": "string" - }, - "type": "array" - }, - "WebhookMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelAdd.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelAdd.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelAdded.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelAdded.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelDestroy.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelDestroy.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelDestroyed.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelDestroyed.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelUpdate.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelUpdate.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnChannelUpdated.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnChannelUpdated.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberAdd.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberAdd.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberAdded.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberAdded.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberRemove.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberRemove.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMemberRemoved.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMemberRemoved.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageRemove.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageRemove.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageRemoved.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageRemoved.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageSend.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageSend.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageSent.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageSent.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageUpdate.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageUpdate.Url": { - "description": "", - "format": "uri", - "type": "string" - }, - "Webhooks.OnMessageUpdated.Method": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Webhooks.OnMessageUpdated.Url": { - "description": "", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ip_messaging.v1.service" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://ip-messaging.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Ip_messaging", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { "/v2/Credentials": { "description": "TODO: Resource-level docs", "get": { diff --git a/spec/json/twilio_lookups.json b/spec/json/twilio_lookups_v1.json similarity index 99% rename from spec/json/twilio_lookups.json rename to spec/json/twilio_lookups_v1.json index 88ec1a8d..bf64fc4e 100644 --- a/spec/json/twilio_lookups.json +++ b/spec/json/twilio_lookups_v1.json @@ -49,7 +49,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Lookups", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_messaging.json b/spec/json/twilio_messaging_v1.json similarity index 99% rename from spec/json/twilio_messaging.json rename to spec/json/twilio_messaging_v1.json index 06c30409..d0219f7c 100644 --- a/spec/json/twilio_messaging.json +++ b/spec/json/twilio_messaging_v1.json @@ -279,7 +279,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Messaging", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_monitor.json b/spec/json/twilio_monitor_v1.json similarity index 99% rename from spec/json/twilio_monitor.json rename to spec/json/twilio_monitor_v1.json index 83d1830a..797fba1b 100644 --- a/spec/json/twilio_monitor.json +++ b/spec/json/twilio_monitor_v1.json @@ -257,7 +257,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Monitor", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_notify.json b/spec/json/twilio_notify_v1.json similarity index 99% rename from spec/json/twilio_notify.json rename to spec/json/twilio_notify_v1.json index 65d7496b..09baff7f 100644 --- a/spec/json/twilio_notify.json +++ b/spec/json/twilio_notify_v1.json @@ -304,7 +304,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Notify", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_numbers.json b/spec/json/twilio_numbers_v2.json similarity index 99% rename from spec/json/twilio_numbers.json rename to spec/json/twilio_numbers_v2.json index c6be4c34..c3908ecf 100644 --- a/spec/json/twilio_numbers.json +++ b/spec/json/twilio_numbers_v2.json @@ -358,7 +358,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Numbers", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json deleted file mode 100644 index d9afda2f..00000000 --- a/spec/json/twilio_preview.json +++ /dev/null @@ -1,13803 +0,0 @@ -{ - "components": { - "schemas": { - "preview.bulk_exports.export": { - "properties": { - "links": { - "type": "object" - }, - "resource_type": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.bulk_exports.export.day": { - "properties": { - "create_date": { - "type": "string" - }, - "day": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "resource_type": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "type": "object" - }, - "preview.bulk_exports.export.day|instance": { - "properties": { - "redirect_to": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.bulk_exports.export.export_custom_job": { - "properties": { - "details": { - "type": "object" - }, - "email": { - "type": "string" - }, - "end_day": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "job_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^JS[0-9a-fA-F]{32}$", - "type": "string" - }, - "resource_type": { - "type": "string" - }, - "start_day": { - "type": "string" - }, - "webhook_method": { - "type": "string" - }, - "webhook_url": { - "type": "string" - } - }, - "type": "object" - }, - "preview.bulk_exports.export.job": { - "properties": { - "details": { - "type": "object" - }, - "email": { - "type": "string" - }, - "end_day": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "job_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^JS[0-9a-fA-F]{32}$", - "type": "string" - }, - "resource_type": { - "type": "string" - }, - "start_day": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "webhook_method": { - "type": "string" - }, - "webhook_url": { - "type": "string" - } - }, - "type": "object" - }, - "preview.bulk_exports.export_configuration": { - "properties": { - "enabled": { - "type": "boolean" - }, - "resource_type": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "webhook_method": { - "type": "string" - }, - "webhook_url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.deployed_devices.fleet": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "default_deployment_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.deployed_devices.fleet.certificate": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "device_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "fleet_sid": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$", - "type": "string" - }, - "thumbprint": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.deployed_devices.fleet.deployment": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "fleet_sid": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - }, - "sync_service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.deployed_devices.fleet.device": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_authenticated": { - "format": "date-time", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "deployment_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "fleet_sid": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "identity": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.deployed_devices.fleet.key": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "device_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "fleet_sid": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "secret": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.hosted_numbers.authorization_document": { - "properties": { - "address_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "cc_emails": { - "items": { - "type": "string" - }, - "type": "array" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" - ], - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_delay": { - "type": "integer" - }, - "capabilities": { - "type": "object" - }, - "cc_emails": { - "items": { - "type": "string" - }, - "type": "array" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "failure_reason": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "incoming_phone_number_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "phone_number": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", - "type": "string" - }, - "signing_document_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ], - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "verification_attempts": { - "type": "integer" - }, - "verification_call_sids": { - "items": { - "type": "string" - }, - "type": "array" - }, - "verification_code": { - "type": "string" - }, - "verification_document_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "verification_type": { - "enum": [ - "phone-call", - "phone-bill" - ], - "type": "string" - } - }, - "type": "object" - }, - "preview.hosted_numbers.hosted_number_order": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_delay": { - "type": "integer" - }, - "capabilities": { - "type": "object" - }, - "cc_emails": { - "items": { - "type": "string" - }, - "type": "array" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "failure_reason": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "incoming_phone_number_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "phone_number": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", - "type": "string" - }, - "signing_document_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ], - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "verification_attempts": { - "type": "integer" - }, - "verification_call_sids": { - "items": { - "type": "string" - }, - "type": "array" - }, - "verification_code": { - "type": "string" - }, - "verification_document_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "verification_type": { - "enum": [ - "phone-call", - "phone-bill" - ], - "type": "string" - } - }, - "type": "object" - }, - "preview.marketplace.available_add_on": { - "properties": { - "configuration_schema": { - "type": "object" - }, - "description": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "pricing_type": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.marketplace.available_add_on.available_add_on_extension": { - "properties": { - "available_add_on_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "product_name": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.marketplace.installed_add_on": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "configuration": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.marketplace.installed_add_on.installed_add_on_extension": { - "properties": { - "enabled": { - "type": "boolean" - }, - "friendly_name": { - "type": "string" - }, - "installed_add_on_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - }, - "product_name": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "acl_enabled": { - "type": "boolean" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "reachability_webhooks_enabled": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "webhook_url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service.document": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "data": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "links": { - "type": "object" - }, - "revision": { - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service.document.document_permission": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "document_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", - "type": "string" - }, - "identity": { - "type": "string" - }, - "manage": { - "type": "boolean" - }, - "read": { - "type": "boolean" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "write": { - "type": "boolean" - } - }, - "type": "object" - }, - "preview.sync.service.sync_list": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "links": { - "type": "object" - }, - "revision": { - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service.sync_list.sync_list_item": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "data": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "index": { - "type": "integer" - }, - "list_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", - "type": "string" - }, - "revision": { - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service.sync_list.sync_list_permission": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "identity": { - "type": "string" - }, - "list_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", - "type": "string" - }, - "manage": { - "type": "boolean" - }, - "read": { - "type": "boolean" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "write": { - "type": "boolean" - } - }, - "type": "object" - }, - "preview.sync.service.sync_map": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "links": { - "type": "object" - }, - "revision": { - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service.sync_map.sync_map_item": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "created_by": { - "type": "string" - }, - "data": { - "type": "object" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "key": { - "type": "string" - }, - "map_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "type": "string" - }, - "revision": { - "type": "string" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.sync.service.sync_map.sync_map_permission": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "identity": { - "type": "string" - }, - "manage": { - "type": "boolean" - }, - "map_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "type": "string" - }, - "read": { - "type": "boolean" - }, - "service_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "write": { - "type": "boolean" - } - }, - "type": "object" - }, - "preview.trusted_comms.branded_call": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "bg_color": { - "type": "string" - }, - "brand_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BZ[0-9a-fA-F]{32}$", - "type": "string" - }, - "branded_channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - }, - "business_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "caller": { - "type": "string" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "font_color": { - "type": "string" - }, - "from": { - "type": "string" - }, - "logo": { - "type": "string" - }, - "phone_number_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "reason": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CQ[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "type": "string" - }, - "to": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "use_case": { - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.branded_channel": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "brand_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BZ[0-9a-fA-F]{32}$", - "type": "string" - }, - "business_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.branded_channel.channel": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "brand_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BZ[0-9a-fA-F]{32}$", - "type": "string" - }, - "branded_channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - }, - "business_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - }, - "phone_number": { - "type": "string" - }, - "phone_number_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.brands_information": { - "properties": { - "file_link": { - "format": "uri", - "type": "string" - }, - "file_link_ttl_in_seconds": { - "type": "string" - }, - "update_time": { - "format": "date-time", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.business": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.business.insights": { - "properties": {}, - "type": "object" - }, - "preview.trusted_comms.business.insights.insights_impressions_rate": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "business_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - }, - "end": { - "format": "date-time", - "type": "string" - }, - "interval": { - "enum": [ - "minute", - "hour", - "day", - "week", - "month" - ], - "type": "string" - }, - "reports": { - "type": "object" - }, - "start": { - "format": "date-time", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.cps": { - "properties": { - "cps_url": { - "format": "uri", - "type": "string" - }, - "phone_number": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.current_call": { - "properties": { - "bg_color": { - "type": "string" - }, - "caller": { - "type": "string" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "font_color": { - "type": "string" - }, - "from": { - "type": "string" - }, - "logo": { - "type": "string" - }, - "manager": { - "type": "string" - }, - "reason": { - "type": "string" - }, - "shield_img": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CQ[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "type": "string" - }, - "to": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "use_case": { - "type": "string" - } - }, - "type": "object" - }, - "preview.trusted_comms.phone_call": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "bg_color": { - "type": "string" - }, - "brand_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BZ[0-9a-fA-F]{32}$", - "type": "string" - }, - "branded_channel_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - }, - "business_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "caller": { - "type": "string" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "font_color": { - "type": "string" - }, - "from": { - "type": "string" - }, - "logo": { - "type": "string" - }, - "phone_number_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "reason": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CQ[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "type": "string" - }, - "to": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "use_case": { - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "callback_events": { - "type": "string" - }, - "callback_url": { - "format": "uri", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "latest_model_build_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "type": "string" - }, - "links": { - "type": "object" - }, - "log_queries": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.assistant_fallback_actions": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.assistant_initiation_actions": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.dialogue": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.field_type": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.field_type.field_value": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "field_type_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "type": "string" - }, - "language": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "type": "string" - }, - "synonym_of": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "value": { - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.model_build": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "build_duration": { - "nullable": true, - "type": "integer" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "error_code": { - "nullable": true, - "type": "integer" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "enqueued", - "building", - "completed", - "failed", - "canceled" - ], - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.query": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "language": { - "type": "string" - }, - "model_build_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "type": "string" - }, - "query": { - "type": "string" - }, - "results": { - "type": "object" - }, - "sample_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UH[0-9a-fA-F]{32}$", - "type": "string" - }, - "source_channel": { - "type": "string" - }, - "status": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.style_sheet": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "actions_url": { - "format": "uri", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.field": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "field_type": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UE[0-9a-fA-F]{32}$", - "type": "string" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.sample": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "language": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - }, - "source_channel": { - "type": "string" - }, - "tagged_text": { - "type": "string" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.task_actions": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.task_statistics": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "fields_count": { - "type": "integer" - }, - "samples_count": { - "type": "integer" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.wireless.command": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "command": { - "type": "string" - }, - "command_mode": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "device_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "direction": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", - "type": "string" - }, - "sim_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.wireless.rate_plan": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "data_enabled": { - "type": "boolean" - }, - "data_limit": { - "type": "integer" - }, - "data_metering": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "international_roaming": { - "items": { - "type": "string" - }, - "type": "array" - }, - "messaging_enabled": { - "type": "boolean" - }, - "national_roaming_enabled": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "voice_enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "preview.wireless.sim": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "commands_callback_method": { - "type": "string" - }, - "commands_callback_url": { - "format": "uri", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "e_id": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "iccid": { - "type": "string" - }, - "links": { - "type": "object" - }, - "rate_plan_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "sms_fallback_url": { - "format": "uri", - "type": "string" - }, - "sms_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "sms_url": { - "format": "uri", - "type": "string" - }, - "status": { - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "voice_fallback_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "voice_fallback_url": { - "format": "uri", - "type": "string" - }, - "voice_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "voice_url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.wireless.sim.usage": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "commands_costs": { - "type": "object" - }, - "commands_usage": { - "type": "object" - }, - "data_costs": { - "type": "object" - }, - "data_usage": { - "type": "object" - }, - "period": { - "type": "object" - }, - "sim_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sim_unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - } - }, - "info": { - "contact": { - "email": "support@twilio.com", - "name": "Twilio Support", - "url": "https://support.twilio.com" - }, - "description": "This is the public Twilio REST API.", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Preview", - "version": "1.3.0" - }, - "openapi": "3.0.1", - "paths": { - "/BulkExports/Exports/Jobs/{JobSid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique string that that we created to identify the Bulk Export job", - "in": "path", - "name": "JobSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^JS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "JobSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^JS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.bulk_exports.export.job" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/BulkExports/Exports/{ResourceType}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Export.", - "parameters": [ - { - "description": "The type of communication \u2013 Messages, Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.bulk_exports.export" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/BulkExports/Exports/{ResourceType}/Configuration": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Export Configuration.", - "parameters": [ - { - "description": "The type of communication \u2013 Messages, Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update a specific Export Configuration.", - "parameters": [ - { - "description": "The type of communication \u2013 Messages, Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Enabled": { - "description": "If true, Twilio will automatically generate every day's file when the day is over.", - "type": "boolean" - }, - "WebhookMethod": { - "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", - "type": "string" - }, - "WebhookUrl": { - "description": "Stores the URL destination for the method specified in webhook_method.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/BulkExports/Exports/{ResourceType}/Days": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Days for a resource.", - "parameters": [ - { - "description": "The type of communication \u2013 Messages, Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "days": { - "items": { - "$ref": "#/components/schemas/preview.bulk_exports.export.day" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/BulkExports/Exports/{ResourceType}/Days/{Day}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Day.", - "parameters": [ - { - "description": "The type of communication \u2013 Messages, Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The ISO 8601 format date of the resources in the file, for a UTC day", - "in": "path", - "name": "Day", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "307": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.bulk_exports.export.day|instance" - } - } - }, - "description": "Temporary Redirect" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/BulkExports/Exports/{ResourceType}/Jobs": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The type of communication \u2013 Messages, Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "jobs": { - "items": { - "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The type of communication \u2013 Messages or Calls", - "in": "path", - "name": "ResourceType", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Email": { - "description": "The optional email to send the completion notification to", - "type": "string" - }, - "EndDay": { - "description": "The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.", - "type": "string" - }, - "FriendlyName": { - "description": "The friendly name specified when creating the job", - "type": "string" - }, - "StartDay": { - "description": "The start day for the custom export specified as a string in the format of yyyy-mm-dd", - "type": "string" - }, - "WebhookMethod": { - "description": "This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.", - "type": "string" - }, - "WebhookUrl": { - "description": "The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied.", - "type": "string" - } - }, - "required": [ - "StartDay", - "EndDay", - "FriendlyName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/DeployedDevices/Fleets": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Fleets belonging to your account.", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "fleets": { - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Create a new Fleet for scoping of deployed devices within your account.", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", - "in": "query", - "name": "DeviceSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "certificates": { - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CertificateData": { - "description": "Provides a URL encoded representation of the public certificate in PEM format.", - "type": "string" - }, - "DeviceSid": { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", - "type": "string" - } - }, - "required": [ - "CertificateData" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { - "delete": { - "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch information about a specific Certificate credential in the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "DeviceSid": { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Deployments belonging to the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "deployments": { - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long.", - "type": "string" - }, - "SyncServiceSid": { - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { - "delete": { - "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch information about a specific Deployment in the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long", - "type": "string" - }, - "SyncServiceSid": { - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Devices belonging to the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", - "in": "query", - "name": "DeploymentSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "devices": { - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "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.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "DeploymentSid": { - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - }, - "Enabled": { - "description": "", - "type": "boolean" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", - "type": "string" - }, - "Identity": { - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", - "type": "string" - }, - "UniqueName": { - "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.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { - "delete": { - "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch information about a specific Device in the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "DeploymentSid": { - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - }, - "Enabled": { - "description": "", - "type": "boolean" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", - "type": "string" - }, - "Identity": { - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", - "in": "query", - "name": "DeviceSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "keys": { - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "DeviceSid": { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { - "delete": { - "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch information about a specific Key credential in the Fleet.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "FleetSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "DeviceSid": { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/DeployedDevices/Fleets/{Sid}": { - "delete": { - "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", - "parameters": [ - { - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch information about a specific Fleet in your account.", - "parameters": [ - { - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update the friendly name property of a specific Fleet in your account.", - "parameters": [ - { - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "DefaultDeploymentSid": { - "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.", - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - }, - "FriendlyName": { - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/HostedNumbers/AuthorizationDocuments": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", - "parameters": [ - { - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "in": "query", - "name": "Email", - "schema": { - "type": "string" - } - }, - { - "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "in": "query", - "name": "Status", - "schema": { - "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressSid": { - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "CcEmails": { - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "ContactPhoneNumber": { - "description": "The contact phone number of the person authorized to sign the Authorization Document.", - "type": "string" - }, - "ContactTitle": { - "description": "The title of the person authorized to sign the Authorization Document for this phone number.", - "type": "string" - }, - "Email": { - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "type": "string" - }, - "HostedNumberOrderSids": { - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "HostedNumberOrderSids", - "AddressSid", - "Email", - "ContactTitle", - "ContactPhoneNumber" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific AuthorizationDocument.", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Updates a specific AuthorizationDocument.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressSid": { - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "CcEmails": { - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", - "items": { - "type": "string" - }, - "type": "array" - }, - "ContactPhoneNumber": { - "description": "The contact phone number of the person authorized to sign the Authorization Document.", - "type": "string" - }, - "ContactTitle": { - "description": "The title of the person authorized to sign the Authorization Document for this phone number.", - "type": "string" - }, - "Email": { - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "type": "string" - }, - "HostedNumberOrderSids": { - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", - "items": { - "type": "string" - }, - "type": "array" - }, - "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" - ], - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "SigningDocumentSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "in": "query", - "name": "Status", - "schema": { - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ], - "type": "string" - } - }, - { - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "in": "query", - "name": "IncomingPhoneNumberSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A human readable description of this resource, up to 64 characters.", - "in": "query", - "name": "FriendlyName", - "schema": { - "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.", - "in": "query", - "name": "UniqueName", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/HostedNumbers/HostedNumberOrders": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", - "parameters": [ - { - "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", - "in": "query", - "name": "Status", - "schema": { - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ], - "type": "string" - } - }, - { - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "in": "query", - "name": "IncomingPhoneNumberSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A human readable description of this resource, up to 64 characters.", - "in": "query", - "name": "FriendlyName", - "schema": { - "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.", - "in": "query", - "name": "UniqueName", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Host a phone number's capability on Twilio's platform.", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AccountSid": { - "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.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "AddressSid": { - "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "CcEmails": { - "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Email": { - "description": "Optional. Email of the owner of this phone number that is being hosted.", - "type": "string" - }, - "FriendlyName": { - "description": "A 64 character string that is a human readable text that describes this resource.", - "type": "string" - }, - "PhoneNumber": { - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format", - "type": "string" - }, - "SmsApplicationSid": { - "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.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsCapability": { - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform.", - "type": "boolean" - }, - "SmsFallbackMethod": { - "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.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "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.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "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.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "StatusCallbackUrl": { - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.", - "format": "uri", - "type": "string" - }, - "UniqueName": { - "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.", - "type": "string" - }, - "VerificationDocumentSid": { - "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.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "VerificationType": { - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", - "enum": [ - "phone-call", - "phone-bill" - ], - "type": "string" - } - }, - "required": [ - "PhoneNumber", - "SmsCapability" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/HostedNumbers/HostedNumberOrders/{Sid}": { - "delete": { - "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific HostedNumberOrder.", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Updates a specific HostedNumberOrder.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallDelay": { - "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.", - "type": "integer" - }, - "CcEmails": { - "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Email": { - "description": "Email of the owner of this phone number that is being hosted.", - "type": "string" - }, - "Extension": { - "description": "Digits to dial after connecting the verification call.", - "type": "string" - }, - "FriendlyName": { - "description": "A 64 character string that is a human readable text that describes this resource.", - "type": "string" - }, - "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.", - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ], - "type": "string" - }, - "UniqueName": { - "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.", - "type": "string" - }, - "VerificationCode": { - "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted.", - "type": "string" - }, - "VerificationDocumentSid": { - "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.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "VerificationType": { - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", - "enum": [ - "phone-call", - "phone-bill" - ], - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "services": { - "items": { - "$ref": "#/components/schemas/preview.sync.service" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AclEnabled": { - "description": "", - "type": "boolean" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "ReachabilityWebhooksEnabled": { - "description": "", - "type": "boolean" - }, - "WebhookUrl": { - "description": "", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Documents": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "documents": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.document" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Data": { - "description": "", - "type": "object" - }, - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Document.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "in": "path", - "name": "DocumentSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { - "delete": { - "description": "Delete a specific Sync Document Permission.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "in": "path", - "name": "DocumentSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Sync Document Permission.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "in": "path", - "name": "DocumentSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update an identity's access to a specific Sync Document.", - "parameters": [ - { - "description": "The unique SID identifier of the Sync Service Instance.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "in": "path", - "name": "DocumentSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Manage": { - "description": "Boolean flag specifying whether the identity can delete the Sync Document.", - "type": "boolean" - }, - "Read": { - "description": "Boolean flag specifying whether the identity can read the Sync Document.", - "type": "boolean" - }, - "Write": { - "description": "Boolean flag specifying whether the identity can update the Sync Document.", - "type": "boolean" - } - }, - "required": [ - "Read", - "Write", - "Manage" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Documents/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The If-Match HTTP request header", - "in": "header", - "name": "If-Match", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The If-Match HTTP request header", - "in": "header", - "name": "If-Match", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Data": { - "description": "", - "type": "object" - } - }, - "required": [ - "Data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Lists": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "lists": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Order", - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "From", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Bounds", - "schema": { - "enum": [ - "inclusive", - "exclusive" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Data": { - "description": "", - "type": "object" - } - }, - "required": [ - "Data" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Index", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "The If-Match HTTP request header", - "in": "header", - "name": "If-Match", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Index", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Index", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "The If-Match HTTP request header", - "in": "header", - "name": "If-Match", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Data": { - "description": "", - "type": "object" - } - }, - "required": [ - "Data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Permissions applying to a Sync List.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { - "delete": { - "description": "Delete a specific Sync List Permission.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Sync List Permission.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update an identity's access to a specific Sync List.", - "parameters": [ - { - "description": "The unique SID identifier of the Sync Service Instance.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "in": "path", - "name": "ListSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Manage": { - "description": "Boolean flag specifying whether the identity can delete the Sync List.", - "type": "boolean" - }, - "Read": { - "description": "Boolean flag specifying whether the identity can read the Sync List.", - "type": "boolean" - }, - "Write": { - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.", - "type": "boolean" - } - }, - "required": [ - "Read", - "Write", - "Manage" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Lists/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Maps": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "maps": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Order", - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "From", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Bounds", - "schema": { - "enum": [ - "inclusive", - "exclusive" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Data": { - "description": "", - "type": "object" - }, - "Key": { - "description": "", - "type": "string" - } - }, - "required": [ - "Key", - "Data" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Key", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The If-Match HTTP request header", - "in": "header", - "name": "If-Match", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Key", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Key", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The If-Match HTTP request header", - "in": "header", - "name": "If-Match", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Data": { - "description": "", - "type": "object" - } - }, - "required": [ - "Data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Map.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Map. Either a SID or a unique name.", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { - "delete": { - "description": "Delete a specific Sync Map Permission.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Map. Either a SID or a unique name.", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Sync Map Permission.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Map. Either a SID or a unique name.", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update an identity's access to a specific Sync Map.", - "parameters": [ - { - "description": "The unique SID identifier of the Sync Service Instance.", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Identifier of the Sync Map. Either a SID or a unique name.", - "in": "path", - "name": "MapSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", - "in": "path", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Manage": { - "description": "Boolean flag specifying whether the identity can delete the Sync Map.", - "type": "boolean" - }, - "Read": { - "description": "Boolean flag specifying whether the identity can read the Sync Map.", - "type": "boolean" - }, - "Write": { - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.", - "type": "boolean" - } - }, - "required": [ - "Read", - "Write", - "Manage" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{ServiceSid}/Maps/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/Sync/Services/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AclEnabled": { - "description": "", - "type": "boolean" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "ReachabilityWebhooksEnabled": { - "description": "", - "type": "boolean" - }, - "WebhookUrl": { - "description": "", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels": { - "description": "TODO: Resource-level docs", - "post": { - "description": "Associate a channel to a branded channel", - "parameters": [ - { - "description": "The unique SID identifier of the Branded Channel. The given phone number is going to be assigned to this Branded Channel", - "in": "path", - "name": "BrandedChannelSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "PhoneNumberSid": { - "description": "The unique SID identifier of the Phone Number of the Phone number to be assigned to the Branded Channel.", - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "PhoneNumberSid" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.branded_channel.channel" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "business_sid", - "brand_sid", - "branded_channel_sid", - "phone_number_sid", - "phone_number", - "url" - ], - "x-path-type": "list" - }, - "/TrustedComms/BrandedChannels/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Branded Channel.", - "parameters": [ - { - "description": "The unique SID identifier of the Branded Channel.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.branded_channel" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "business_sid", - "brand_sid", - "sid", - "links", - "url" - ], - "x-path-type": "instance" - }, - "/TrustedComms/BrandsInformation": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve the newest available BrandInformation", - "parameters": [ - { - "description": "The If-None-Match HTTP request header", - "in": "header", - "name": "If-None-Match", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.brands_information" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "update_time", - "file_link", - "file_link_ttl_in_seconds", - "url" - ], - "x-path-type": "instance" - }, - "/TrustedComms/Business/BrandedCalls": { - "description": "TODO: Resource-level docs", - "post": { - "description": "Brands a Call without actually placing it. Useful for cases when the Customer wants to initiate the call themselves right after calling this endpoint. This can be used also through a TwiML using `+1500456`, and right after doing `+1500456`", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallSid": { - "description": "The Call sid this Branded Call should link to.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "From": { - "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", - "type": "string" - }, - "Reason": { - "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", - "type": "string" - }, - "To": { - "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "type": "string" - } - }, - "required": [ - "From", - "To", - "Reason" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.branded_call" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "bg_color", - "brand_sid", - "branded_channel_sid", - "business_sid", - "call_sid", - "caller", - "created_at", - "font_color", - "from", - "logo", - "phone_number_sid", - "reason", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "list" - }, - "/TrustedComms/Business/PhoneCalls": { - "description": "TODO: Resource-level docs", - "post": { - "description": "Initiates a Branded Call.", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApplicationSid": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "CallerId": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "FallbackMethod": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "FallbackUrl": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "format": "uri", - "type": "string" - }, - "From": { - "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", - "type": "string" - }, - "MachineDetection": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "MachineDetectionSilenceTimeout": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "MachineDetectionSpeechEndThreshold": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "MachineDetectionSpeechThreshold": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "MachineDetectionTimeout": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "Method": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Reason": { - "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", - "type": "string" - }, - "Record": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "boolean" - }, - "RecordingChannels": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "RecordingStatusCallback": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "RecordingStatusCallbackEvent": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "items": { - "type": "string" - }, - "type": "array" - }, - "RecordingStatusCallbackMethod": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SendDigits": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "SipAuthPassword": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "SipAuthUsername": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "StatusCallback": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "format": "uri", - "type": "string" - }, - "StatusCallbackEvent": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "items": { - "type": "string" - }, - "type": "array" - }, - "StatusCallbackMethod": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Timeout": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "To": { - "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "type": "string" - }, - "Trim": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "Url": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "format": "uri", - "type": "string" - } - }, - "required": [ - "From", - "To" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.phone_call" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "bg_color", - "brand_sid", - "branded_channel_sid", - "business_sid", - "call_sid", - "caller", - "created_at", - "font_color", - "from", - "logo", - "phone_number_sid", - "reason", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "list" - }, - "/TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Impressions Rate.", - "parameters": [ - { - "description": "The unique SID identifier of the Business to filter by.", - "in": "path", - "name": "BusinessSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Brand to filter by.", - "in": "query", - "name": "BrandSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BZ[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Branded Channel to filter by.", - "in": "query", - "name": "BrandedChannelSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Phone Number to filter by.", - "in": "query", - "name": "PhoneNumberSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The 2-letter ISO 3166 code of the Country to filter by.", - "in": "query", - "name": "Country", - "schema": { - "type": "string" - } - }, - { - "description": "The start date that for this Impressions Rate, given in ISO 8601 format. Default value is 30 days ago.", - "in": "query", - "name": "Start", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The end date that for this Impressions Rate, given in ISO 8601 format. Default value is current timestamp.", - "in": "query", - "name": "End", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The Interval of this Impressions Rate. One of `minute`, `hour`, `day`, `week` or `month`.", - "in": "query", - "name": "Interval", - "schema": { - "enum": [ - "minute", - "hour", - "day", - "week", - "month" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "start", - "end", - "interval", - "business_sid", - "reports", - "url" - ], - "x-path-type": "instance" - }, - "/TrustedComms/Businesses/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Business.", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this Business.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.business" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "sid", - "url", - "links" - ], - "x-path-type": "instance" - }, - "/TrustedComms/CPS": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Call Placement Service (CPS) given a phone number via `X-XCNAM-Sensitive-Phone-Number` header.", - "parameters": [ - { - "description": "The X-Xcnam-Sensitive-Phone-Number HTTP request header", - "in": "header", - "name": "X-Xcnam-Sensitive-Phone-Number", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.cps" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "cps_url", - "phone_number", - "url" - ], - "x-path-type": "instance" - }, - "/TrustedComms/CurrentCall": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a current call given the originating and terminating number via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` headers.", - "parameters": [ - { - "description": "The X-Xcnam-Sensitive-Phone-Number-From HTTP request header", - "in": "header", - "name": "X-Xcnam-Sensitive-Phone-Number-From", - "schema": { - "type": "string" - } - }, - { - "description": "The X-Xcnam-Sensitive-Phone-Number-To HTTP request header", - "in": "header", - "name": "X-Xcnam-Sensitive-Phone-Number-To", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.current_call" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "bg_color", - "caller", - "created_at", - "font_color", - "from", - "logo", - "manager", - "reason", - "shield_img", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "instance" - }, - "/marketplace/AvailableAddOns": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Add-ons currently available to be installed.", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_add_ons": { - "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Extensions for the Available Add-on.", - "parameters": [ - { - "description": "The SID of the AvailableAddOn resource with the extensions to read.", - "in": "path", - "name": "AvailableAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "extensions": { - "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Extension for the Available Add-on.", - "parameters": [ - { - "description": "The SID of the AvailableAddOn resource with the extension to fetch.", - "in": "path", - "name": "AvailableAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the AvailableAddOn Extension resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/marketplace/AvailableAddOns/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Add-on currently available to be installed.", - "parameters": [ - { - "description": "The SID of the AvailableAddOn resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/marketplace/InstalledAddOns": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Add-ons currently installed on this Account.", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "installed_add_ons": { - "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Install an Add-on for the Account specified.", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AcceptTermsOfService": { - "description": "Whether the Terms of Service were accepted.", - "type": "boolean" - }, - "AvailableAddOnSid": { - "description": "The SID of the AvaliableAddOn to install.", - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - }, - "Configuration": { - "description": "The JSON object that represents the configuration of the new Add-on being installed.", - "type": "object" - }, - "UniqueName": { - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", - "type": "string" - } - }, - "required": [ - "AvailableAddOnSid", - "AcceptTermsOfService" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Extensions for the Installed Add-on.", - "parameters": [ - { - "description": "The SID of the InstalledAddOn resource with the extensions to read.", - "in": "path", - "name": "InstalledAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "extensions": { - "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Extension for the Installed Add-on.", - "parameters": [ - { - "description": "The SID of the InstalledAddOn resource with the extension to fetch.", - "in": "path", - "name": "InstalledAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the InstalledAddOn Extension resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update an Extension for an Add-on installation.", - "parameters": [ - { - "description": "The SID of the InstalledAddOn resource with the extension to update.", - "in": "path", - "name": "InstalledAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the InstalledAddOn Extension resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Enabled": { - "description": "Whether the Extension should be invoked.", - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/marketplace/InstalledAddOns/{Sid}": { - "delete": { - "description": "Remove an Add-on installation from your account", - "parameters": [ - { - "description": "The SID of the InstalledAddOn resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Add-on currently installed on this Account.", - "parameters": [ - { - "description": "The SID of the InstalledAddOn resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Update an Add-on installation for the Account specified.", - "parameters": [ - { - "description": "The SID of the InstalledAddOn resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "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", - "type": "object" - }, - "UniqueName": { - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "assistants": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackEvents": { - "description": "Space-separated list of callback events that will trigger callbacks.", - "type": "string" - }, - "CallbackUrl": { - "description": "A user-provided URL to send event callbacks to.", - "format": "uri", - "type": "string" - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", - "type": "object" - }, - "FriendlyName": { - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", - "type": "object" - }, - "LogQueries": { - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", - "type": "boolean" - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant", - "type": "object" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.dialogue" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/FallbackActions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FallbackActions": { - "description": "", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "field_types": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "UniqueName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An ISO language-country string of the value. For example: *en-US*", - "in": "query", - "name": "Language", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "field_values": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Language": { - "description": "An ISO language-country string of the value.", - "type": "string" - }, - "SynonymOf": { - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.", - "type": "string" - }, - "Value": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "Language", - "Value" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/InitiationActions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "InitiationActions": { - "description": "", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "model_builds": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "StatusCallback": { - "description": "", - "format": "uri", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Queries": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "schema": { - "type": "string" - } - }, - { - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "in": "query", - "name": "ModelBuild", - "schema": { - "type": "string" - } - }, - { - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", - "in": "query", - "name": "Status", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "queries": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Field": { - "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*", - "type": "string" - }, - "Language": { - "description": "An ISO language-country string of the sample.", - "type": "string" - }, - "ModelBuild": { - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "type": "string" - }, - "Query": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.", - "type": "string" - }, - "Tasks": { - "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*", - "type": "string" - } - }, - "required": [ - "Language", - "Query" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "SampleSid": { - "description": "An optional reference to the Sample created from this query.", - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - }, - "Status": { - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/StyleSheet": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Returns Style sheet JSON object for this Assistant", - "parameters": [ - { - "description": "The unique ID of the Assistant", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", - "parameters": [ - { - "description": "The unique ID of the Assistant", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "StyleSheet": { - "description": "The JSON Style sheet string", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "tasks": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", - "type": "object" - }, - "ActionsUrl": { - "description": "User-provided HTTP endpoint where from the assistant fetches actions", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "UniqueName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", - "type": "object" - }, - "ActionsUrl": { - "description": "User-provided HTTP endpoint where from the assistant fetches actions", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Returns JSON actions for this Task.", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Actions": { - "description": "The JSON actions that instruct the Assistant how to perform this task.", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "fields": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FieldType": { - "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FieldType", - "UniqueName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "samples": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Language": { - "description": "An ISO language-country string of the sample.", - "type": "string" - }, - "SourceChannel": { - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", - "type": "string" - }, - "TaggedText": { - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", - "type": "string" - } - }, - "required": [ - "Language", - "TaggedText" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Language": { - "description": "An ISO language-country string of the sample.", - "type": "string" - }, - "SourceChannel": { - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", - "type": "string" - }, - "TaggedText": { - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackEvents": { - "description": "Space-separated list of callback events that will trigger callbacks.", - "type": "string" - }, - "CallbackUrl": { - "description": "A user-provided URL to send event callbacks to.", - "format": "uri", - "type": "string" - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", - "type": "object" - }, - "FriendlyName": { - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", - "type": "object" - }, - "LogQueries": { - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", - "type": "boolean" - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant", - "type": "object" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/Commands": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "Device", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Sim", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Status", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Direction", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "commands": { - "items": { - "$ref": "#/components/schemas/preview.wireless.command" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackMethod": { - "description": "", - "type": "string" - }, - "CallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "Command": { - "description": "", - "type": "string" - }, - "CommandMode": { - "description": "", - "type": "string" - }, - "Device": { - "description": "", - "type": "string" - }, - "IncludeSid": { - "description": "", - "type": "string" - }, - "Sim": { - "description": "", - "type": "string" - } - }, - "required": [ - "Command" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.command" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/wireless/Commands/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.command" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/RatePlans": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "rate_plans": { - "items": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CommandsEnabled": { - "description": "", - "type": "boolean" - }, - "DataEnabled": { - "description": "", - "type": "boolean" - }, - "DataLimit": { - "description": "", - "type": "integer" - }, - "DataMetering": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "InternationalRoaming": { - "description": "", - "items": { - "type": "string" - }, - "type": "array" - }, - "MessagingEnabled": { - "description": "", - "type": "boolean" - }, - "NationalRoamingEnabled": { - "description": "", - "type": "boolean" - }, - "UniqueName": { - "description": "", - "type": "string" - }, - "VoiceEnabled": { - "description": "", - "type": "boolean" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/wireless/RatePlans/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "", - "type": "string" - }, - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/Sims": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "Status", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Iccid", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "RatePlan", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "EId", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "SimRegistrationCode", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "sims": { - "items": { - "$ref": "#/components/schemas/preview.wireless.sim" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/wireless/Sims/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackMethod": { - "description": "", - "type": "string" - }, - "CallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "CommandsCallbackMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "CommandsCallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "RatePlan": { - "description": "", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "Status": { - "description": "", - "type": "string" - }, - "UniqueName": { - "description": "", - "type": "string" - }, - "VoiceFallbackMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/Sims/{SimSid}/Usage": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "SimSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "End", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Start", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim.usage" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - } - }, - "tags": [ - { - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", - "name": "Preview" - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_preview_bulk_exports.json b/spec/json/twilio_preview_bulk_exports.json new file mode 100644 index 00000000..b82aa004 --- /dev/null +++ b/spec/json/twilio_preview_bulk_exports.json @@ -0,0 +1,710 @@ +{ + "components": { + "schemas": { + "preview.bulk_exports.export": { + "properties": { + "links": { + "type": "object" + }, + "resource_type": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.day": { + "properties": { + "create_date": { + "type": "string" + }, + "day": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.day|instance": { + "properties": { + "redirect_to": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.export_custom_job": { + "properties": { + "details": { + "type": "object" + }, + "email": { + "type": "string" + }, + "end_day": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "job_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "start_day": { + "type": "string" + }, + "webhook_method": { + "type": "string" + }, + "webhook_url": { + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.job": { + "properties": { + "details": { + "type": "object" + }, + "email": { + "type": "string" + }, + "end_day": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "job_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "start_day": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_method": { + "type": "string" + }, + "webhook_url": { + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export_configuration": { + "properties": { + "enabled": { + "type": "boolean" + }, + "resource_type": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_method": { + "type": "string" + }, + "webhook_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/BulkExports/Exports/Jobs/{JobSid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique string that that we created to identify the Bulk Export job", + "in": "path", + "name": "JobSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "JobSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export.job" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Export.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}/Configuration": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Export Configuration.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update a specific Export Configuration.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "If true, Twilio will automatically generate every day's file when the day is over.", + "type": "boolean" + }, + "WebhookMethod": { + "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", + "type": "string" + }, + "WebhookUrl": { + "description": "Stores the URL destination for the method specified in webhook_method.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}/Days": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Days for a resource.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "days": { + "items": { + "$ref": "#/components/schemas/preview.bulk_exports.export.day" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/BulkExports/Exports/{ResourceType}/Days/{Day}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Day.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The ISO 8601 format date of the resources in the file, for a UTC day", + "in": "path", + "name": "Day", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "307": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export.day|instance" + } + } + }, + "description": "Temporary Redirect" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}/Jobs": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "jobs": { + "items": { + "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The type of communication \u2013 Messages or Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Email": { + "description": "The optional email to send the completion notification to", + "type": "string" + }, + "EndDay": { + "description": "The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.", + "type": "string" + }, + "FriendlyName": { + "description": "The friendly name specified when creating the job", + "type": "string" + }, + "StartDay": { + "description": "The start day for the custom export specified as a string in the format of yyyy-mm-dd", + "type": "string" + }, + "WebhookMethod": { + "description": "This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.", + "type": "string" + }, + "WebhookUrl": { + "description": "The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied.", + "type": "string" + } + }, + "required": [ + "StartDay", + "EndDay", + "FriendlyName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_deployed_devices.json b/spec/json/twilio_preview_deployed_devices.json new file mode 100644 index 00000000..6d1e1120 --- /dev/null +++ b/spec/json/twilio_preview_deployed_devices.json @@ -0,0 +1,1806 @@ +{ + "components": { + "schemas": { + "preview.deployed_devices.fleet": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "default_deployment_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.certificate": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "device_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + }, + "thumbprint": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.deployment": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "sync_service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.device": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_authenticated": { + "format": "date-time", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "deployment_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "identity": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.key": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "device_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "secret": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/DeployedDevices/Fleets": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Fleets belonging to your account.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "fleets": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create a new Fleet for scoping of deployed devices within your account.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "in": "query", + "name": "DeviceSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificates": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CertificateData": { + "description": "Provides a URL encoded representation of the public certificate in PEM format.", + "type": "string" + }, + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", + "type": "string" + } + }, + "required": [ + "CertificateData" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "delete": { + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Certificate credential in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Deployments belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "deployments": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long.", + "type": "string" + }, + "SyncServiceSid": { + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { + "delete": { + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Deployment in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long", + "type": "string" + }, + "SyncServiceSid": { + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Devices belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", + "in": "query", + "name": "DeploymentSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "devices": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "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.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeploymentSid": { + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "Enabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", + "type": "string" + }, + "Identity": { + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", + "type": "string" + }, + "UniqueName": { + "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.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { + "delete": { + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Device in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeploymentSid": { + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "Enabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", + "type": "string" + }, + "Identity": { + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", + "in": "query", + "name": "DeviceSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "keys": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "delete": { + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Key credential in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{Sid}": { + "delete": { + "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "parameters": [ + { + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Fleet in your account.", + "parameters": [ + { + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the friendly name property of a specific Fleet in your account.", + "parameters": [ + { + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DefaultDeploymentSid": { + "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_hosted_numbers.json b/spec/json/twilio_preview_hosted_numbers.json new file mode 100644 index 00000000..c9085a2f --- /dev/null +++ b/spec/json/twilio_preview_hosted_numbers.json @@ -0,0 +1,1276 @@ +{ + "components": { + "schemas": { + "preview.hosted_numbers.authorization_document": { + "properties": { + "address_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "cc_emails": { + "items": { + "type": "string" + }, + "type": "array" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "address_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_delay": { + "type": "integer" + }, + "capabilities": { + "type": "object" + }, + "cc_emails": { + "items": { + "type": "string" + }, + "type": "array" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string" + }, + "extension": { + "type": "string" + }, + "failure_reason": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "incoming_phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + }, + "signing_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "verification_attempts": { + "type": "integer" + }, + "verification_call_sids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "verification_code": { + "type": "string" + }, + "verification_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "verification_type": { + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + }, + "preview.hosted_numbers.hosted_number_order": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "address_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_delay": { + "type": "integer" + }, + "capabilities": { + "type": "object" + }, + "cc_emails": { + "items": { + "type": "string" + }, + "type": "array" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string" + }, + "extension": { + "type": "string" + }, + "failure_reason": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "incoming_phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + }, + "signing_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "verification_attempts": { + "type": "integer" + }, + "verification_call_sids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "verification_code": { + "type": "string" + }, + "verification_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "verification_type": { + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/HostedNumbers/AuthorizationDocuments": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "parameters": [ + { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "in": "query", + "name": "Email", + "schema": { + "type": "string" + } + }, + { + "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "in": "query", + "name": "Status", + "schema": { + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ContactPhoneNumber": { + "description": "The contact phone number of the person authorized to sign the Authorization Document.", + "type": "string" + }, + "ContactTitle": { + "description": "The title of the person authorized to sign the Authorization Document for this phone number.", + "type": "string" + }, + "Email": { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "type": "string" + }, + "HostedNumberOrderSids": { + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific AuthorizationDocument.", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates a specific AuthorizationDocument.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", + "items": { + "type": "string" + }, + "type": "array" + }, + "ContactPhoneNumber": { + "description": "The contact phone number of the person authorized to sign the Authorization Document.", + "type": "string" + }, + "ContactTitle": { + "description": "The title of the person authorized to sign the Authorization Document for this phone number.", + "type": "string" + }, + "Email": { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "type": "string" + }, + "HostedNumberOrderSids": { + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "SigningDocumentSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "in": "query", + "name": "Status", + "schema": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + } + }, + { + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "in": "query", + "name": "PhoneNumber", + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "in": "query", + "name": "IncomingPhoneNumberSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "A human readable description of this resource, up to 64 characters.", + "in": "query", + "name": "FriendlyName", + "schema": { + "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.", + "in": "query", + "name": "UniqueName", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/HostedNumbers/HostedNumberOrders": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "parameters": [ + { + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "in": "query", + "name": "Status", + "schema": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + } + }, + { + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "in": "query", + "name": "PhoneNumber", + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "in": "query", + "name": "IncomingPhoneNumberSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "A human readable description of this resource, up to 64 characters.", + "in": "query", + "name": "FriendlyName", + "schema": { + "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.", + "in": "query", + "name": "UniqueName", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Host a phone number's capability on Twilio's platform.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "AddressSid": { + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Email": { + "description": "Optional. Email of the owner of this phone number that is being hosted.", + "type": "string" + }, + "FriendlyName": { + "description": "A 64 character string that is a human readable text that describes this resource.", + "type": "string" + }, + "PhoneNumber": { + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format", + "type": "string" + }, + "SmsApplicationSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsCapability": { + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform.", + "type": "boolean" + }, + "SmsFallbackMethod": { + "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.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "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.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "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.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "StatusCallbackUrl": { + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "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.", + "type": "string" + }, + "VerificationDocumentSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "VerificationType": { + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/HostedNumbers/HostedNumberOrders/{Sid}": { + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific HostedNumberOrder.", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates a specific HostedNumberOrder.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallDelay": { + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.", + "type": "integer" + }, + "CcEmails": { + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Email": { + "description": "Email of the owner of this phone number that is being hosted.", + "type": "string" + }, + "Extension": { + "description": "Digits to dial after connecting the verification call.", + "type": "string" + }, + "FriendlyName": { + "description": "A 64 character string that is a human readable text that describes this resource.", + "type": "string" + }, + "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.", + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "UniqueName": { + "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.", + "type": "string" + }, + "VerificationCode": { + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted.", + "type": "string" + }, + "VerificationDocumentSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "VerificationType": { + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_marketplace.json b/spec/json/twilio_preview_marketplace.json new file mode 100644 index 00000000..3b760d20 --- /dev/null +++ b/spec/json/twilio_preview_marketplace.json @@ -0,0 +1,951 @@ +{ + "components": { + "schemas": { + "preview.marketplace.available_add_on": { + "properties": { + "configuration_schema": { + "type": "object" + }, + "description": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "pricing_type": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.available_add_on.available_add_on_extension": { + "properties": { + "available_add_on_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "product_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.installed_add_on": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "configuration": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "description": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.installed_add_on.installed_add_on_extension": { + "properties": { + "enabled": { + "type": "boolean" + }, + "friendly_name": { + "type": "string" + }, + "installed_add_on_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + }, + "product_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/marketplace/AvailableAddOns": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Add-ons currently available to be installed.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "available_add_ons": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Extensions for the Available Add-on.", + "parameters": [ + { + "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "in": "path", + "name": "AvailableAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "extensions": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Extension for the Available Add-on.", + "parameters": [ + { + "description": "The SID of the AvailableAddOn resource with the extension to fetch.", + "in": "path", + "name": "AvailableAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the AvailableAddOn Extension resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/marketplace/AvailableAddOns/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Add-on currently available to be installed.", + "parameters": [ + { + "description": "The SID of the AvailableAddOn resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/marketplace/InstalledAddOns": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Add-ons currently installed on this Account.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "installed_add_ons": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Install an Add-on for the Account specified.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AcceptTermsOfService": { + "description": "Whether the Terms of Service were accepted.", + "type": "boolean" + }, + "AvailableAddOnSid": { + "description": "The SID of the AvaliableAddOn to install.", + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed.", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", + "type": "string" + } + }, + "required": [ + "AvailableAddOnSid", + "AcceptTermsOfService" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Extensions for the Installed Add-on.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource with the extensions to read.", + "in": "path", + "name": "InstalledAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "extensions": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Extension for the Installed Add-on.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource with the extension to fetch.", + "in": "path", + "name": "InstalledAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an Extension for an Add-on installation.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource with the extension to update.", + "in": "path", + "name": "InstalledAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the InstalledAddOn Extension resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "Whether the Extension should be invoked.", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/marketplace/InstalledAddOns/{Sid}": { + "delete": { + "description": "Remove an Add-on installation from your account", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Add-on currently installed on this Account.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an Add-on installation for the Account specified.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "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", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_sync.json b/spec/json/twilio_preview_sync.json new file mode 100644 index 00000000..53dcf331 --- /dev/null +++ b/spec/json/twilio_preview_sync.json @@ -0,0 +1,3231 @@ +{ + "components": { + "schemas": { + "preview.sync.service": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "acl_enabled": { + "type": "boolean" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "reachability_webhooks_enabled": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.document": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "data": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ET[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.document.document_permission": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ET[0-9a-fA-F]{32}$", + "type": "string" + }, + "identity": { + "type": "string" + }, + "manage": { + "type": "boolean" + }, + "read": { + "type": "boolean" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "write": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.sync.service.sync_list": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_list.sync_list_item": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "data": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "index": { + "type": "integer" + }, + "list_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "type": "string" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_list.sync_list_permission": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "identity": { + "type": "string" + }, + "list_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "type": "string" + }, + "manage": { + "type": "boolean" + }, + "read": { + "type": "boolean" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "write": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.sync.service.sync_map": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MP[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_map.sync_map_item": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "data": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "key": { + "type": "string" + }, + "map_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MP[0-9a-fA-F]{32}$", + "type": "string" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_map.sync_map_permission": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "identity": { + "type": "string" + }, + "manage": { + "type": "boolean" + }, + "map_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MP[0-9a-fA-F]{32}$", + "type": "string" + }, + "read": { + "type": "boolean" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "write": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/Sync/Services": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "services": { + "items": { + "$ref": "#/components/schemas/preview.sync.service" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "ReachabilityWebhooksEnabled": { + "description": "", + "type": "boolean" + }, + "WebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Documents": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "documents": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.document" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync Document.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { + "delete": { + "description": "Delete a specific Sync Document Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Sync Document Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync Document.", + "parameters": [ + { + "description": "The unique SID identifier of the Sync Service Instance.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync Document.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync Document.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can update the Sync Document.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Lists": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "lists": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Order", + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "From", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Bounds", + "schema": { + "enum": [ + "inclusive", + "exclusive" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Index", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Index", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Index", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync List.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "delete": { + "description": "Delete a specific Sync List Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Sync List Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync List.", + "parameters": [ + { + "description": "The unique SID identifier of the Sync Service Instance.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync List.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync List.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Lists/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Maps": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "maps": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Order", + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "From", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Bounds", + "schema": { + "enum": [ + "inclusive", + "exclusive" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + }, + "Key": { + "description": "", + "type": "string" + } + }, + "required": [ + "Key", + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Key", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Key", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Key", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { + "delete": { + "description": "Delete a specific Sync Map Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Sync Map Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync Map.", + "parameters": [ + { + "description": "The unique SID identifier of the Sync Service Instance.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync Map.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync Map.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "ReachabilityWebhooksEnabled": { + "description": "", + "type": "boolean" + }, + "WebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_trusted_comms.json b/spec/json/twilio_preview_trusted_comms.json new file mode 100644 index 00000000..222e3f07 --- /dev/null +++ b/spec/json/twilio_preview_trusted_comms.json @@ -0,0 +1,1238 @@ +{ + "components": { + "schemas": { + "preview.trusted_comms.branded_call": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "bg_color": { + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "branded_channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "caller": { + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "font_color": { + "type": "string" + }, + "from": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "reason": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CQ[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "use_case": { + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.branded_channel": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.branded_channel.channel": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "branded_channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.brands_information": { + "properties": { + "file_link": { + "format": "uri", + "type": "string" + }, + "file_link_ttl_in_seconds": { + "type": "string" + }, + "update_time": { + "format": "date-time", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.business": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.business.insights": { + "properties": {}, + "type": "object" + }, + "preview.trusted_comms.business.insights.insights_impressions_rate": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "end": { + "format": "date-time", + "type": "string" + }, + "interval": { + "enum": [ + "minute", + "hour", + "day", + "week", + "month" + ], + "type": "string" + }, + "reports": { + "type": "object" + }, + "start": { + "format": "date-time", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.cps": { + "properties": { + "cps_url": { + "format": "uri", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.current_call": { + "properties": { + "bg_color": { + "type": "string" + }, + "caller": { + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "font_color": { + "type": "string" + }, + "from": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "shield_img": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CQ[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "use_case": { + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.phone_call": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "bg_color": { + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "branded_channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "caller": { + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "font_color": { + "type": "string" + }, + "from": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "reason": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CQ[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "use_case": { + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels": { + "description": "TODO: Resource-level docs", + "post": { + "description": "Associate a channel to a branded channel", + "parameters": [ + { + "description": "The unique SID identifier of the Branded Channel. The given phone number is going to be assigned to this Branded Channel", + "in": "path", + "name": "BrandedChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "PhoneNumberSid": { + "description": "The unique SID identifier of the Phone Number of the Phone number to be assigned to the Branded Channel.", + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "PhoneNumberSid" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.branded_channel.channel" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "business_sid", + "brand_sid", + "branded_channel_sid", + "phone_number_sid", + "phone_number", + "url" + ], + "x-path-type": "list" + }, + "/TrustedComms/BrandedChannels/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Branded Channel.", + "parameters": [ + { + "description": "The unique SID identifier of the Branded Channel.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.branded_channel" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "business_sid", + "brand_sid", + "sid", + "links", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/BrandsInformation": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve the newest available BrandInformation", + "parameters": [ + { + "description": "The If-None-Match HTTP request header", + "in": "header", + "name": "If-None-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.brands_information" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "update_time", + "file_link", + "file_link_ttl_in_seconds", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/Business/BrandedCalls": { + "description": "TODO: Resource-level docs", + "post": { + "description": "Brands a Call without actually placing it. Useful for cases when the Customer wants to initiate the call themselves right after calling this endpoint. This can be used also through a TwiML using `+1500456`, and right after doing `+1500456`", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallSid": { + "description": "The Call sid this Branded Call should link to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "From": { + "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", + "type": "string" + }, + "Reason": { + "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", + "type": "string" + }, + "To": { + "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + } + }, + "required": [ + "From", + "To", + "Reason" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.branded_call" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "bg_color", + "brand_sid", + "branded_channel_sid", + "business_sid", + "call_sid", + "caller", + "created_at", + "font_color", + "from", + "logo", + "phone_number_sid", + "reason", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "list" + }, + "/TrustedComms/Business/PhoneCalls": { + "description": "TODO: Resource-level docs", + "post": { + "description": "Initiates a Branded Call.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApplicationSid": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "CallerId": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "FallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackUrl": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + }, + "From": { + "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", + "type": "string" + }, + "MachineDetection": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "MachineDetectionSilenceTimeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionSpeechEndThreshold": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionSpeechThreshold": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionTimeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "Method": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Reason": { + "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", + "type": "string" + }, + "Record": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "boolean" + }, + "RecordingChannels": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "RecordingStatusCallbackEvent": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "items": { + "type": "string" + }, + "type": "array" + }, + "RecordingStatusCallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SendDigits": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "SipAuthPassword": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "SipAuthUsername": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "StatusCallback": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "items": { + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Timeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "To": { + "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + }, + "Trim": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "Url": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + } + }, + "required": [ + "From", + "To" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.phone_call" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "bg_color", + "brand_sid", + "branded_channel_sid", + "business_sid", + "call_sid", + "caller", + "created_at", + "font_color", + "from", + "logo", + "phone_number_sid", + "reason", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "list" + }, + "/TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Impressions Rate.", + "parameters": [ + { + "description": "The unique SID identifier of the Business to filter by.", + "in": "path", + "name": "BusinessSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique SID identifier of the Brand to filter by.", + "in": "query", + "name": "BrandSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique SID identifier of the Branded Channel to filter by.", + "in": "query", + "name": "BrandedChannelSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique SID identifier of the Phone Number to filter by.", + "in": "query", + "name": "PhoneNumberSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The 2-letter ISO 3166 code of the Country to filter by.", + "in": "query", + "name": "Country", + "schema": { + "type": "string" + } + }, + { + "description": "The start date that for this Impressions Rate, given in ISO 8601 format. Default value is 30 days ago.", + "in": "query", + "name": "Start", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "The end date that for this Impressions Rate, given in ISO 8601 format. Default value is current timestamp.", + "in": "query", + "name": "End", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "The Interval of this Impressions Rate. One of `minute`, `hour`, `day`, `week` or `month`.", + "in": "query", + "name": "Interval", + "schema": { + "enum": [ + "minute", + "hour", + "day", + "week", + "month" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "start", + "end", + "interval", + "business_sid", + "reports", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/Businesses/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Business.", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this Business.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.business" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "sid", + "url", + "links" + ], + "x-path-type": "instance" + }, + "/TrustedComms/CPS": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Call Placement Service (CPS) given a phone number via `X-XCNAM-Sensitive-Phone-Number` header.", + "parameters": [ + { + "description": "The X-Xcnam-Sensitive-Phone-Number HTTP request header", + "in": "header", + "name": "X-Xcnam-Sensitive-Phone-Number", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.cps" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "cps_url", + "phone_number", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/CurrentCall": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a current call given the originating and terminating number via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` headers.", + "parameters": [ + { + "description": "The X-Xcnam-Sensitive-Phone-Number-From HTTP request header", + "in": "header", + "name": "X-Xcnam-Sensitive-Phone-Number-From", + "schema": { + "type": "string" + } + }, + { + "description": "The X-Xcnam-Sensitive-Phone-Number-To HTTP request header", + "in": "header", + "name": "X-Xcnam-Sensitive-Phone-Number-To", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.current_call" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "bg_color", + "caller", + "created_at", + "font_color", + "from", + "logo", + "manager", + "reason", + "shield_img", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_understand.json b/spec/json/twilio_preview_understand.json new file mode 100644 index 00000000..5f0437b2 --- /dev/null +++ b/spec/json/twilio_preview_understand.json @@ -0,0 +1,3588 @@ +{ + "components": { + "schemas": { + "preview.understand.assistant": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "callback_events": { + "type": "string" + }, + "callback_url": { + "format": "uri", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "latest_model_build_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "log_queries": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.assistant_fallback_actions": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.assistant_initiation_actions": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.dialogue": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UK[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.field_type": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.field_type.field_value": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "field_type_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "type": "string" + }, + "language": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "type": "string" + }, + "synonym_of": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.model_build": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "build_duration": { + "nullable": true, + "type": "integer" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "error_code": { + "nullable": true, + "type": "integer" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "enqueued", + "building", + "completed", + "failed", + "canceled" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.query": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "language": { + "type": "string" + }, + "model_build_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "type": "string" + }, + "query": { + "type": "string" + }, + "results": { + "type": "object" + }, + "sample_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UH[0-9a-fA-F]{32}$", + "type": "string" + }, + "source_channel": { + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.style_sheet": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "actions_url": { + "format": "uri", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.field": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "field_type": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UE[0-9a-fA-F]{32}$", + "type": "string" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.sample": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "language": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "source_channel": { + "type": "string" + }, + "tagged_text": { + "type": "string" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.task_actions": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.task_statistics": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "fields_count": { + "type": "integer" + }, + "samples_count": { + "type": "integer" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/understand/Assistants": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "assistants": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Space-separated list of callback events that will trigger callbacks.", + "type": "string" + }, + "CallbackUrl": { + "description": "A user-provided URL to send event callbacks to.", + "format": "uri", + "type": "string" + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", + "type": "object" + }, + "FriendlyName": { + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", + "type": "object" + }, + "LogQueries": { + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant", + "type": "object" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.dialogue" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/FallbackActions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FallbackActions": { + "description": "", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "field_types": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "An ISO language-country string of the value. For example: *en-US*", + "in": "query", + "name": "Language", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "field_values": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the value.", + "type": "string" + }, + "SynonymOf": { + "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.", + "type": "string" + }, + "Value": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "Language", + "Value" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/InitiationActions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "InitiationActions": { + "description": "", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/ModelBuilds": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "model_builds": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StatusCallback": { + "description": "", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Queries": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "An ISO language-country string of the sample.", + "in": "query", + "name": "Language", + "schema": { + "type": "string" + } + }, + { + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "in": "query", + "name": "ModelBuild", + "schema": { + "type": "string" + } + }, + { + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "in": "query", + "name": "Status", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "queries": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Field": { + "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*", + "type": "string" + }, + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "ModelBuild": { + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "type": "string" + }, + "Query": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.", + "type": "string" + }, + "Tasks": { + "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*", + "type": "string" + } + }, + "required": [ + "Language", + "Query" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "SampleSid": { + "description": "An optional reference to the Sample created from this query.", + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "Status": { + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/StyleSheet": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Returns Style sheet JSON object for this Assistant", + "parameters": [ + { + "description": "The unique ID of the Assistant", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", + "parameters": [ + { + "description": "The unique ID of the Assistant", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StyleSheet": { + "description": "The JSON Style sheet string", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "tasks": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "User-provided HTTP endpoint where from the assistant fetches actions", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "User-provided HTTP endpoint where from the assistant fetches actions", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Returns JSON actions for this Task.", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "The JSON actions that instruct the Assistant how to perform this task.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "fields": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FieldType": { + "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FieldType", + "UniqueName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "An ISO language-country string of the sample.", + "in": "query", + "name": "Language", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "samples": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", + "type": "string" + } + }, + "required": [ + "Language", + "TaggedText" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Space-separated list of callback events that will trigger callbacks.", + "type": "string" + }, + "CallbackUrl": { + "description": "A user-provided URL to send event callbacks to.", + "format": "uri", + "type": "string" + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", + "type": "object" + }, + "FriendlyName": { + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", + "type": "object" + }, + "LogQueries": { + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant", + "type": "object" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview_wireless.json b/spec/json/twilio_preview_wireless.json new file mode 100644 index 00000000..380c1749 --- /dev/null +++ b/spec/json/twilio_preview_wireless.json @@ -0,0 +1,1255 @@ +{ + "components": { + "schemas": { + "preview.wireless.command": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "command": { + "type": "string" + }, + "command_mode": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "device_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "direction": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$", + "type": "string" + }, + "sim_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.wireless.rate_plan": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "data_enabled": { + "type": "boolean" + }, + "data_limit": { + "type": "integer" + }, + "data_metering": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "international_roaming": { + "items": { + "type": "string" + }, + "type": "array" + }, + "messaging_enabled": { + "type": "boolean" + }, + "national_roaming_enabled": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WP[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "voice_enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.wireless.sim": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "commands_callback_method": { + "type": "string" + }, + "commands_callback_url": { + "format": "uri", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "e_id": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "iccid": { + "type": "string" + }, + "links": { + "type": "object" + }, + "rate_plan_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WP[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "sms_fallback_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "sms_fallback_url": { + "format": "uri", + "type": "string" + }, + "sms_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "sms_url": { + "format": "uri", + "type": "string" + }, + "status": { + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "voice_fallback_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "voice_fallback_url": { + "format": "uri", + "type": "string" + }, + "voice_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "voice_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.wireless.sim.usage": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "commands_costs": { + "type": "object" + }, + "commands_usage": { + "type": "object" + }, + "data_costs": { + "type": "object" + }, + "data_usage": { + "type": "object" + }, + "period": { + "type": "object" + }, + "sim_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "sim_unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/wireless/Commands": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "query", + "name": "Device", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Sim", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Status", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Direction", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "commands": { + "items": { + "$ref": "#/components/schemas/preview.wireless.command" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "", + "type": "string" + }, + "CallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "Command": { + "description": "", + "type": "string" + }, + "CommandMode": { + "description": "", + "type": "string" + }, + "Device": { + "description": "", + "type": "string" + }, + "IncludeSid": { + "description": "", + "type": "string" + }, + "Sim": { + "description": "", + "type": "string" + } + }, + "required": [ + "Command" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.command" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/wireless/Commands/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.command" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/RatePlans": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "rate_plans": { + "items": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommandsEnabled": { + "description": "", + "type": "boolean" + }, + "DataEnabled": { + "description": "", + "type": "boolean" + }, + "DataLimit": { + "description": "", + "type": "integer" + }, + "DataMetering": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "InternationalRoaming": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + }, + "MessagingEnabled": { + "description": "", + "type": "boolean" + }, + "NationalRoamingEnabled": { + "description": "", + "type": "boolean" + }, + "UniqueName": { + "description": "", + "type": "string" + }, + "VoiceEnabled": { + "description": "", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/wireless/RatePlans/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/Sims": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "query", + "name": "Status", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Iccid", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "RatePlan", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "EId", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "SimRegistrationCode", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "sims": { + "items": { + "$ref": "#/components/schemas/preview.wireless.sim" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/wireless/Sims/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "", + "type": "string" + }, + "CallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "CommandsCallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CommandsCallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "RatePlan": { + "description": "", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "Status": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + }, + "VoiceFallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/Sims/{SimSid}/Usage": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "SimSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "End", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Start", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim.usage" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_pricing.json b/spec/json/twilio_pricing_v1.json similarity index 68% rename from spec/json/twilio_pricing.json rename to spec/json/twilio_pricing_v1.json index e02c0656..180048a9 100644 --- a/spec/json/twilio_pricing.json +++ b/spec/json/twilio_pricing_v1.json @@ -298,158 +298,6 @@ } }, "type": "object" - }, - "pricing.v2.voice": { - "properties": { - "links": { - "type": "object" - }, - "name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "pricing.v2.voice.voice_country": { - "properties": { - "country": { - "type": "string" - }, - "iso_country": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "pricing.v2.voice.voice_country|instance": { - "properties": { - "country": { - "type": "string" - }, - "inbound_call_prices": { - "items": { - "properties": { - "base_price": { - "type": "number" - }, - "current_price": { - "type": "number" - }, - "number_type": { - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "iso_country": { - "type": "string" - }, - "outbound_prefix_prices": { - "items": { - "properties": { - "base_price": { - "type": "number" - }, - "current_price": { - "type": "number" - }, - "destination_prefixes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "friendly_name": { - "type": "string" - }, - "origination_prefixes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "type": "array" - }, - "price_unit": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "pricing.v2.voice.voice_number": { - "properties": { - "country": { - "type": "string" - }, - "destination_number": { - "type": "string" - }, - "inbound_call_price": { - "properties": { - "base_price": { - "type": "number" - }, - "current_price": { - "type": "number" - }, - "number_type": { - "type": "string" - } - }, - "type": "object" - }, - "iso_country": { - "type": "string" - }, - "origination_number": { - "type": "string" - }, - "outbound_call_prices": { - "items": { - "properties": { - "base_price": { - "type": "number" - }, - "current_price": { - "type": "number" - }, - "origination_prefixes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "type": "array" - }, - "price_unit": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" } }, "securitySchemes": { @@ -472,7 +320,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { @@ -927,195 +775,6 @@ "price_unit" ], "x-path-type": "instance" - }, - "/v2/Voice/Countries": { - "description": "Voice pricing by country", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "countries": { - "items": { - "$ref": "#/components/schemas/pricing.v2.voice.voice_country" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://pricing.twilio.com" - } - ], - "x-default-output-properties": [ - "country", - "price_unit" - ], - "x-path-type": "list" - }, - "/v2/Voice/Countries/{IsoCountry}": { - "description": "Voice pricing by country", - "get": { - "description": "Fetch a specific Country.", - "parameters": [ - { - "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based voice pricing information to fetch.", - "in": "path", - "name": "IsoCountry", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pricing.v2.voice.voice_country|instance" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://pricing.twilio.com" - } - ], - "x-default-output-properties": [ - "country", - "price_unit" - ], - "x-path-type": "instance" - }, - "/v2/Voice/Numbers/{DestinationNumber}": { - "description": "Voice pricing for a specific phone number", - "get": { - "description": "Fetch pricing information for a specific destination and, optionally, origination phone number.", - "parameters": [ - { - "description": "The destination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.", - "in": "path", - "name": "DestinationNumber", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.", - "in": "query", - "name": "OriginationNumber", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pricing.v2.voice.voice_number" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://pricing.twilio.com" - } - ], - "x-default-output-properties": [ - "country", - "inbound_call_price", - "price_unit" - ], - "x-path-type": "instance" } }, "tags": [ diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json new file mode 100644 index 00000000..e30ad1f6 --- /dev/null +++ b/spec/json/twilio_pricing_v2.json @@ -0,0 +1,377 @@ +{ + "components": { + "schemas": { + "pricing.v2.voice": { + "properties": { + "links": { + "type": "object" + }, + "name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "pricing.v2.voice.voice_country": { + "properties": { + "country": { + "type": "string" + }, + "iso_country": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "pricing.v2.voice.voice_country|instance": { + "properties": { + "country": { + "type": "string" + }, + "inbound_call_prices": { + "items": { + "properties": { + "base_price": { + "type": "number" + }, + "current_price": { + "type": "number" + }, + "number_type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "iso_country": { + "type": "string" + }, + "outbound_prefix_prices": { + "items": { + "properties": { + "base_price": { + "type": "number" + }, + "current_price": { + "type": "number" + }, + "destination_prefixes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "friendly_name": { + "type": "string" + }, + "origination_prefixes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "price_unit": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "pricing.v2.voice.voice_number": { + "properties": { + "country": { + "type": "string" + }, + "destination_number": { + "type": "string" + }, + "inbound_call_price": { + "properties": { + "base_price": { + "type": "number" + }, + "current_price": { + "type": "number" + }, + "number_type": { + "type": "string" + } + }, + "type": "object" + }, + "iso_country": { + "type": "string" + }, + "origination_number": { + "type": "string" + }, + "outbound_call_prices": { + "items": { + "properties": { + "base_price": { + "type": "number" + }, + "current_price": { + "type": "number" + }, + "origination_prefixes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "price_unit": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Pricing", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/v2/Voice/Countries": { + "description": "Voice pricing by country", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "countries": { + "items": { + "$ref": "#/components/schemas/pricing.v2.voice.voice_country" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://pricing.twilio.com" + } + ], + "x-default-output-properties": [ + "country", + "price_unit" + ], + "x-path-type": "list" + }, + "/v2/Voice/Countries/{IsoCountry}": { + "description": "Voice pricing by country", + "get": { + "description": "Fetch a specific Country.", + "parameters": [ + { + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based voice pricing information to fetch.", + "in": "path", + "name": "IsoCountry", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing.v2.voice.voice_country|instance" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://pricing.twilio.com" + } + ], + "x-default-output-properties": [ + "country", + "price_unit" + ], + "x-path-type": "instance" + }, + "/v2/Voice/Numbers/{DestinationNumber}": { + "description": "Voice pricing for a specific phone number", + "get": { + "description": "Fetch pricing information for a specific destination and, optionally, origination phone number.", + "parameters": [ + { + "description": "The destination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.", + "in": "path", + "name": "DestinationNumber", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.", + "in": "query", + "name": "OriginationNumber", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing.v2.voice.voice_number" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://pricing.twilio.com" + } + ], + "x-default-output-properties": [ + "country", + "inbound_call_price", + "price_unit" + ], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "This product is Generally Available.", + "name": "GA" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_proxy.json b/spec/json/twilio_proxy_v1.json similarity index 99% rename from spec/json/twilio_proxy.json rename to spec/json/twilio_proxy_v1.json index 068fefa5..41a9e95e 100644 --- a/spec/json/twilio_proxy.json +++ b/spec/json/twilio_proxy_v1.json @@ -628,7 +628,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Proxy", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_serverless.json b/spec/json/twilio_serverless_v1.json similarity index 99% rename from spec/json/twilio_serverless.json rename to spec/json/twilio_serverless_v1.json index f3385b73..6495ac9d 100644 --- a/spec/json/twilio_serverless.json +++ b/spec/json/twilio_serverless_v1.json @@ -601,7 +601,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Serverless", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json new file mode 100644 index 00000000..d0886428 --- /dev/null +++ b/spec/json/twilio_studio_v1.json @@ -0,0 +1,1880 @@ +{ + "components": { + "schemas": { + "studio.v1.flow": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "draft", + "published" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "version": { + "type": "integer" + } + }, + "type": "object" + }, + "studio.v1.flow.engagement": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "contact_channel_address": { + "type": "string" + }, + "contact_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "active", + "ended" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.engagement.engagement_context": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "engagement_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.engagement.step": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "engagement_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + }, + "transitioned_from": { + "type": "string" + }, + "transitioned_to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.engagement.step.step_context": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "engagement_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "step_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.execution": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "contact_channel_address": { + "type": "string" + }, + "contact_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "active", + "ended" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.execution.execution_context": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "execution_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.execution.execution_step": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "execution_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + }, + "transitioned_from": { + "type": "string" + }, + "transitioned_to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v1.flow.execution.execution_step.execution_step_context": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "execution_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "step_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Studio", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/Flows": { + "description": "Studio flows", + "get": { + "description": "Retrieve a list of all Flows.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "flows": { + "items": { + "$ref": "#/components/schemas/studio.v1.flow" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "status", + "version" + ], + "x-path-type": "list" + }, + "/v1/Flows/{FlowSid}/Engagements": { + "description": "[DEPRECATED] Excecutions of Studio flows", + "get": { + "description": "Retrieve a list of all Engagements for the Flow.", + "parameters": [ + { + "description": "The SID of the Flow to read Engagements from.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "engagements": { + "items": { + "$ref": "#/components/schemas/studio.v1.flow.engagement" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "Triggers a new Engagement for the Flow", + "parameters": [ + { + "description": "The SID of the Flow.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`", + "type": "string" + }, + "Parameters": { + "description": "A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.", + "type": "object" + }, + "To": { + "description": "The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.engagement" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "contact_sid", + "status", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context": { + "description": "[DEPRECATED] JSON context for engagements", + "get": { + "description": "Retrieve the most recent context for an Engagement.", + "parameters": [ + { + "description": "The SID of the Flow.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Engagement.", + "in": "path", + "name": "EngagementSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.engagement.engagement_context" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "context" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps": { + "description": "Steps within a Studio flow", + "get": { + "description": "Retrieve a list of all Steps for an Engagement.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to read.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Engagement with the Step to read.", + "in": "path", + "name": "EngagementSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "steps": { + "items": { + "$ref": "#/components/schemas/studio.v1.flow.engagement.step" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "name", + "transitioned_from", + "transitioned_to" + ], + "x-path-type": "list" + }, + "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}": { + "description": "Steps within a Studio flow", + "get": { + "description": "Retrieve a Step.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Engagement with the Step to fetch.", + "in": "path", + "name": "EngagementSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Step resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.engagement.step" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "name", + "transitioned_from", + "transitioned_to" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context": { + "description": "JSON context for individual steps", + "get": { + "description": "Retrieve the context for an Engagement Step.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Engagement with the Step to fetch.", + "in": "path", + "name": "EngagementSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Step to fetch", + "in": "path", + "name": "StepSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.engagement.step.step_context" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "context" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Engagements/{Sid}": { + "delete": { + "description": "Delete this Engagement and all Steps relating to it.", + "parameters": [ + { + "description": "The SID of the Flow to delete Engagements from.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Engagement resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "[DEPRECATED] Excecutions of Studio flows", + "get": { + "description": "Retrieve an Engagement", + "parameters": [ + { + "description": "The SID of the Flow.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Engagement resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.engagement" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "contact_sid", + "status", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Executions": { + "description": "Executions of Studio flows", + "get": { + "description": "Retrieve a list of all Executions for the Flow.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resources to read.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", + "in": "query", + "name": "DateCreatedFrom", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", + "in": "query", + "name": "DateCreatedTo", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "executions": { + "items": { + "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "Triggers a new Execution for the Flow", + "parameters": [ + { + "description": "The SID of the Excecution's Flow.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", + "type": "string" + }, + "Parameters": { + "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", + "type": "object" + }, + "To": { + "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.execution" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "contact_sid", + "status", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context": { + "description": "JSON context for executions", + "get": { + "description": "Retrieve the most recent context for an Execution.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution context to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution context to fetch.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.execution.execution_context" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "context" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { + "description": "Individual steps within an execution", + "get": { + "description": "Retrieve a list of all Steps for an Execution.", + "parameters": [ + { + "description": "The SID of the Flow with the Steps to read.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution with the Steps to read.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "steps": { + "items": { + "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "name", + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { + "description": "Individual steps within an execution", + "get": { + "description": "Retrieve a Step.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource with the Step to fetch.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the ExecutionStep resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "name", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { + "description": "JSON context for an individual step within an execution", + "get": { + "description": "Retrieve the context for an Execution Step.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource with the Step to fetch.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Step to fetch.", + "in": "path", + "name": "StepSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "context" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{FlowSid}/Executions/{Sid}": { + "delete": { + "description": "Delete the Execution and all Steps relating to it.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resources to delete.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Executions of Studio flows", + "get": { + "description": "Retrieve an Execution", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resource to fetch", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.execution" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "Update the status of an Execution to `ended`.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resources to update.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The status of the Execution. Can only be `ended`.", + "enum": [ + "active", + "ended" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow.execution" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "contact_sid", + "status", + "date_created" + ], + "x-path-type": "instance" + }, + "/v1/Flows/{Sid}": { + "delete": { + "description": "Delete a specific Flow.", + "parameters": [ + { + "description": "The SID of the Flow resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Studio flows", + "get": { + "description": "Retrieve a specific Flow.", + "parameters": [ + { + "description": "The SID of the Flow resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v1.flow" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "status", + "version" + ], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "This product is Generally Available.", + "name": "GA" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json new file mode 100644 index 00000000..7911cffe --- /dev/null +++ b/spec/json/twilio_studio_v2.json @@ -0,0 +1,1681 @@ +{ + "components": { + "schemas": { + "studio.v2.flow": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "commit_message": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "definition": { + "type": "object" + }, + "errors": { + "items": { + "type": "object" + }, + "type": "array" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "integer" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "draft", + "published" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "valid": { + "type": "boolean" + }, + "warnings": { + "items": { + "type": "object" + }, + "type": "array" + }, + "webhook_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v2.flow.execution": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "contact_channel_address": { + "type": "string" + }, + "context": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "active", + "ended" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v2.flow.execution.execution_context": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "execution_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v2.flow.execution.execution_step": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "execution_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + }, + "transitioned_from": { + "type": "string" + }, + "transitioned_to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v2.flow.execution.execution_step.execution_step_context": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "context": { + "type": "object" + }, + "execution_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + }, + "flow_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "step_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v2.flow.flow_revision": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "commit_message": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "definition": { + "type": "object" + }, + "errors": { + "items": { + "type": "object" + }, + "type": "array" + }, + "friendly_name": { + "type": "string" + }, + "revision": { + "type": "integer" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "draft", + "published" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "valid": { + "type": "boolean" + } + }, + "type": "object" + }, + "studio.v2.flow.test_user": { + "properties": { + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "test_users": { + "items": { + "type": "string" + }, + "type": "array" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "studio.v2.flow_validate": { + "properties": { + "valid": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Studio", + "version": "5.12.0" + }, + "openapi": "3.0.1", + "paths": { + "/v2/Flows": { + "description": "Studio flows", + "get": { + "description": "Retrieve a list of all Flows.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "flows": { + "items": { + "$ref": "#/components/schemas/studio.v2.flow" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "post": { + "description": "Create a Flow.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommitMessage": { + "description": "Description on change made in the revision.", + "type": "string" + }, + "Definition": { + "description": "JSON representation of flow definition.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the Flow.", + "type": "string" + }, + "Status": { + "description": "The status of the Flow. Can be: `draft` or `published`.", + "enum": [ + "draft", + "published" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Status", + "Definition" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "status", + "revision" + ], + "x-path-type": "list" + }, + "/v2/Flows/Validate": { + "description": "TODO: Resource-level docs", + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommitMessage": { + "description": "", + "type": "string" + }, + "Definition": { + "description": "", + "type": "object" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "Status": { + "description": "", + "enum": [ + "draft", + "published" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Status", + "Definition" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow_validate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "valid" + ], + "x-path-type": "list" + }, + "/v2/Flows/{FlowSid}/Executions": { + "description": "Executions of Studio flows", + "get": { + "description": "Retrieve a list of all Executions for the Flow.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resources to read.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", + "in": "query", + "name": "DateCreatedFrom", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", + "in": "query", + "name": "DateCreatedTo", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "executions": { + "items": { + "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "post": { + "description": "Triggers a new Execution for the Flow", + "parameters": [ + { + "description": "The SID of the Excecution's Flow.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", + "type": "string" + }, + "Parameters": { + "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", + "type": "object" + }, + "To": { + "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.execution" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "status", + "date_created" + ], + "x-path-type": "list" + }, + "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context": { + "description": "JSON context for executions", + "get": { + "description": "Retrieve the most recent context for an Execution.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution context to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution context to fetch.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.execution.execution_context" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "context" + ], + "x-path-type": "instance" + }, + "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { + "description": "Individual steps within an execution", + "get": { + "description": "Retrieve a list of all Steps for an Execution.", + "parameters": [ + { + "description": "The SID of the Flow with the Steps to read.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution with the Steps to read.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "steps": { + "items": { + "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "name", + "date_created" + ], + "x-path-type": "list" + }, + "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { + "description": "Individual steps within an execution", + "get": { + "description": "Retrieve a Step.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource with the Step to fetch.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the ExecutionStep resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "name", + "date_created" + ], + "x-path-type": "instance" + }, + "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { + "description": "JSON context for an individual step within an execution", + "get": { + "description": "Retrieve the context for an Execution Step.", + "parameters": [ + { + "description": "The SID of the Flow with the Step to fetch.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource with the Step to fetch.", + "in": "path", + "name": "ExecutionSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Step to fetch.", + "in": "path", + "name": "StepSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FT[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "context" + ], + "x-path-type": "instance" + }, + "/v2/Flows/{FlowSid}/Executions/{Sid}": { + "delete": { + "description": "Delete the Execution and all Steps relating to it.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resources to delete.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "description": "Executions of Studio flows", + "get": { + "description": "Retrieve an Execution", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resource to fetch", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.execution" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "post": { + "description": "Update the status of an Execution to `ended`.", + "parameters": [ + { + "description": "The SID of the Flow with the Execution resources to update.", + "in": "path", + "name": "FlowSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the Execution resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FN[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The status of the Execution. Can only be `ended`.", + "enum": [ + "active", + "ended" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.execution" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "status", + "date_created" + ], + "x-path-type": "instance" + }, + "/v2/Flows/{Sid}": { + "delete": { + "description": "Delete a specific Flow.", + "parameters": [ + { + "description": "The SID of the Flow resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "description": "Studio flows", + "get": { + "description": "Retrieve a specific Flow.", + "parameters": [ + { + "description": "The SID of the Flow resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "post": { + "description": "Update a Flow.", + "parameters": [ + { + "description": "The SID of the Flow resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommitMessage": { + "description": "Description on change made in the revision.", + "type": "string" + }, + "Definition": { + "description": "JSON representation of flow definition.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the Flow.", + "type": "string" + }, + "Status": { + "description": "The status of the Flow. Can be: `draft` or `published`.", + "enum": [ + "draft", + "published" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "status", + "revision" + ], + "x-path-type": "instance" + }, + "/v2/Flows/{Sid}/Revisions": { + "description": "Studio flows revisions", + "get": { + "description": "Retrieve a list of all Flows revisions.", + "parameters": [ + { + "description": "The SID of the Flow resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "revisions": { + "items": { + "$ref": "#/components/schemas/studio.v2.flow.flow_revision" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "status", + "revision" + ], + "x-path-type": "list" + }, + "/v2/Flows/{Sid}/Revisions/{Revision}": { + "description": "Studio flows revisions", + "get": { + "description": "Retrieve a specific Flow revision.", + "parameters": [ + { + "description": "The SID of the Flow resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Specific Revision number or can be `LatestPublished` and `LatestRevision`.", + "in": "path", + "name": "Revision", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.flow_revision" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "status", + "revision" + ], + "x-path-type": "instance" + }, + "/v2/Flows/{Sid}/TestUsers": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.test_user" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "TestUsers": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "TestUsers" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/studio.v2.flow.test_user" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://studio.twilio.com" + } + ], + "x-default-output-properties": [ + "test_users" + ], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution.", + "name": "Beta" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_supersim.json b/spec/json/twilio_supersim_v1.json similarity index 99% rename from spec/json/twilio_supersim.json rename to spec/json/twilio_supersim_v1.json index 302a8059..27de475f 100644 --- a/spec/json/twilio_supersim.json +++ b/spec/json/twilio_supersim_v1.json @@ -341,7 +341,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Supersim", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_sync.json b/spec/json/twilio_sync_v1.json similarity index 99% rename from spec/json/twilio_sync.json rename to spec/json/twilio_sync_v1.json index 0da7a034..784f0140 100644 --- a/spec/json/twilio_sync.json +++ b/spec/json/twilio_sync_v1.json @@ -516,7 +516,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Sync", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_taskrouter.json b/spec/json/twilio_taskrouter_v1.json similarity index 99% rename from spec/json/twilio_taskrouter.json rename to spec/json/twilio_taskrouter_v1.json index ae901e8d..24eb7da1 100644 --- a/spec/json/twilio_taskrouter.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -1401,7 +1401,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Taskrouter", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trunking.json b/spec/json/twilio_trunking_v1.json similarity index 99% rename from spec/json/twilio_trunking.json rename to spec/json/twilio_trunking_v1.json index d78486a5..9edf8b4a 100644 --- a/spec/json/twilio_trunking.json +++ b/spec/json/twilio_trunking_v1.json @@ -448,7 +448,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Trunking", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_verify.json b/spec/json/twilio_verify_v2.json similarity index 99% rename from spec/json/twilio_verify.json rename to spec/json/twilio_verify_v2.json index 1f492d3f..5561ff30 100644 --- a/spec/json/twilio_verify.json +++ b/spec/json/twilio_verify_v2.json @@ -616,7 +616,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Verify", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_video.json b/spec/json/twilio_video_v1.json similarity index 99% rename from spec/json/twilio_video.json rename to spec/json/twilio_video_v1.json index 309afb69..22ac2118 100644 --- a/spec/json/twilio_video.json +++ b/spec/json/twilio_video_v1.json @@ -774,7 +774,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Video", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_voice.json b/spec/json/twilio_voice_v1.json similarity index 99% rename from spec/json/twilio_voice.json rename to spec/json/twilio_voice_v1.json index 0c9e54a7..887398e8 100644 --- a/spec/json/twilio_voice.json +++ b/spec/json/twilio_voice_v1.json @@ -398,7 +398,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Voice", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_wireless.json b/spec/json/twilio_wireless_v1.json similarity index 99% rename from spec/json/twilio_wireless.json rename to spec/json/twilio_wireless_v1.json index 40f556c8..cee2c01e 100644 --- a/spec/json/twilio_wireless.json +++ b/spec/json/twilio_wireless_v1.json @@ -438,7 +438,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Wireless", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/yaml/twilio_accounts.yaml b/spec/yaml/twilio_accounts_v1.yaml similarity index 99% rename from spec/yaml/twilio_accounts.yaml rename to spec/yaml/twilio_accounts_v1.yaml index 3a73edba..2a710173 100644 --- a/spec/yaml/twilio_accounts.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -104,7 +104,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Accounts - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: diff --git a/spec/yaml/twilio_api.yaml b/spec/yaml/twilio_api_v2010.yaml similarity index 99% rename from spec/yaml/twilio_api.yaml rename to spec/yaml/twilio_api_v2010.yaml index 398aed30..612d259c 100644 --- a/spec/yaml/twilio_api.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -6064,7 +6064,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Api - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: diff --git a/spec/yaml/twilio_autopilot.yaml b/spec/yaml/twilio_autopilot_v1.yaml similarity index 99% rename from spec/yaml/twilio_autopilot.yaml rename to spec/yaml/twilio_autopilot_v1.yaml index 01e80b3d..81b36a09 100644 --- a/spec/yaml/twilio_autopilot.yaml +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -520,7 +520,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Autopilot - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Assistants: diff --git a/spec/yaml/twilio_bulkexports.yaml b/spec/yaml/twilio_bulkexports_v1.yaml similarity index 99% rename from spec/yaml/twilio_bulkexports.yaml rename to spec/yaml/twilio_bulkexports_v1.yaml index 99215a4b..07652f12 100644 --- a/spec/yaml/twilio_bulkexports.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -110,7 +110,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Bulkexports - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Exports/Jobs/{JobSid}: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml new file mode 100644 index 00000000..a378da19 --- /dev/null +++ b/spec/yaml/twilio_chat_v1.yaml @@ -0,0 +1,2876 @@ +components: + schemas: + chat.v1.credential: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + sandbox: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + type: + enum: + - gcm + - apn + - fcm + type: string + url: + format: uri + type: string + type: object + chat.v1.service: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + consumption_report_interval: + type: integer + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + default_channel_creator_role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + default_channel_role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + default_service_role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + friendly_name: + type: string + limits: + type: object + links: + type: object + notifications: + type: object + post_webhook_url: + type: string + pre_webhook_url: + type: string + reachability_enabled: + type: boolean + read_status_enabled: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + typing_indicator_timeout: + type: integer + url: + format: uri + type: string + webhook_filters: + items: + type: string + type: array + webhook_method: + type: string + webhooks: + type: object + type: object + chat.v1.service.channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + members_count: + type: integer + messages_count: + type: integer + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + type: + enum: + - public + - private + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + chat.v1.service.channel.invite: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + identity: + type: string + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^IN[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + chat.v1.service.channel.member: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + identity: + type: string + last_consumed_message_index: + nullable: true + type: integer + last_consumption_timestamp: + format: date-time + type: string + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + chat.v1.service.channel.message: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + body: + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + from: + type: string + index: + type: integer + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + to: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + was_edited: + type: boolean + type: object + chat.v1.service.role: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + permissions: + items: + type: string + type: array + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: + enum: + - channel + - deployment + type: string + url: + format: uri + type: string + type: object + chat.v1.service.user: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + identity: + type: string + is_notifiable: + type: boolean + is_online: + type: boolean + joined_channels_count: + type: integer + links: + type: object + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + chat.v1.service.user.user_channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + last_consumed_message_index: + nullable: true + type: integer + links: + type: object + member_sid: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + status: + enum: + - joined + - invited + - not_participating + type: string + unread_messages_count: + nullable: true + type: integer + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Chat + version: 5.12.0 +openapi: 3.0.1 +paths: + /v1/Credentials: + description: Credentials for push notifications channels + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + credentials: + items: + $ref: '#/components/schemas/chat.v1.credential' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ApiKey: + description: '[GCM only] The API key for the project that was obtained + from the Google Developer console for your GCM Service application + credential.' + type: string + Certificate: + description: "[APN only] The URL encoded representation of the certificate.\ + \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n\ + -----END CERTIFICATE-----`" + type: string + FriendlyName: + description: A descriptive string that you create to describe the + new resource. It can be up to 64 characters long. + type: string + PrivateKey: + description: '[APN only] The URL encoded representation of the private + key. For example, + + `-----BEGIN RSA PRIVATE KEY----- + + MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. + + -----END RSA PRIVATE KEY-----`' + type: string + Sandbox: + description: '[APN only] Whether to send the credential to sandbox + APNs. Can be `true` to send to sandbox APNs or `false` to send + to production.' + type: boolean + Secret: + description: '[FCM only] The **Server key** of your project from + the Firebase console, found under Settings / Cloud messaging.' + type: string + Type: + description: 'The type of push-notification service the credential + is for. Can be: `gcm`, `fcm`, or `apn`.' + enum: + - gcm + - apn + - fcm + type: string + required: + - Type + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.credential' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id001 + - sid + - friendly_name + - type + x-path-type: list + /v1/Credentials/{Sid}: + delete: + description: '' + parameters: + - description: The Twilio-provided string that uniquely identifies the Credential + resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Credentials for push notifications channels + get: + description: '' + parameters: + - description: The Twilio-provided string that uniquely identifies the Credential + resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.credential' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The Twilio-provided string that uniquely identifies the Credential + resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ApiKey: + description: '[GCM only] The API key for the project that was obtained + from the Google Developer console for your GCM Service application + credential.' + type: string + Certificate: + description: "[APN only] The URL encoded representation of the certificate.\ + \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n\ + -----END CERTIFICATE-----`" + type: string + FriendlyName: + description: A descriptive string that you create to describe the + resource. It can be up to 64 characters long. + type: string + PrivateKey: + description: '[APN only] The URL encoded representation of the private + key. For example, + + `-----BEGIN RSA PRIVATE KEY----- + + MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. + + -----END RSA PRIVATE KEY-----`' + type: string + Sandbox: + description: '[APN only] Whether to send the credential to sandbox + APNs. Can be `true` to send to sandbox APNs or `false` to send + to production.' + type: boolean + Secret: + description: '[FCM only] The **Server key** of your project from + the Firebase console, found under Settings / Cloud messaging.' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.credential' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /v1/Services: + description: Top level scope for all chat resources + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + services: + items: + $ref: '#/components/schemas/chat.v1.service' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: A descriptive string that you create to describe the + resource. It can be up to 64 characters long. + type: string + required: + - FriendlyName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id008 + - sid + - friendly_name + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels: + description: Channels represent chat rooms + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: 'The visibility of the Channels to read. Can be: `public` or + `private` and defaults to `public`.' + in: query + name: Type + schema: + items: + enum: + - public + - private + type: string + type: array + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + channels: + items: + $ref: '#/components/schemas/chat.v1.service.channel' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to create the resource under. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: A valid JSON string that contains application-specific + data. + type: string + FriendlyName: + description: A descriptive string that you create to describe the + new resource. It can be up to 64 characters long. + type: string + Type: + description: 'The visibility of the channel. Can be: `public` or + `private` and defaults to `public`.' + enum: + - public + - private + type: string + UniqueName: + description: An application-defined string that uniquely identifies + the resource. It can be used to address the resource in place + of the resource's `sid` in the URL. This value must be 64 characters + or less in length and be unique within the Service. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id005 + - sid + - unique_name + - friendly_name + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: + description: Pending invitations to users to become channel members + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the resources to read belong to. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s + `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) + for more details. + in: query + name: Identity + schema: + items: + type: string + type: array + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + invites: + items: + $ref: '#/components/schemas/chat.v1.service.channel.invite' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to create the resource under. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the new resource belongs to. + in: path + name: ChannelSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Identity: + description: The `identity` value that uniquely identifies the new + resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) + within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). + See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) + for more info. + type: string + RoleSid: + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + assigned to the new member. + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + required: + - Identity + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.invite' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id002 + - sid + - identity + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: + delete: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to delete the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the resource to delete belongs to. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The Twilio-provided string that uniquely identifies the Invite + resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IN[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Pending invitations to users to become channel members + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to fetch the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the resource to fetch belongs to. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The Twilio-provided string that uniquely identifies the Invite + resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IN[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.invite' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: + description: Users joined to specific channels + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the members to read belong to. Can be the Channel resource's `sid` or `unique_name` + value. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s + `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) + for more details. + in: query + name: Identity + schema: + items: + type: string + type: array + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + members: + items: + $ref: '#/components/schemas/chat.v1.service.channel.member' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to create the resource under. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the new member belongs to. Can be the Channel resource's `sid` or `unique_name`. + in: path + name: ChannelSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Identity: + description: The `identity` value that uniquely identifies the new + resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) + within the [Service](https://www.twilio.com/docs/api/chat/rest/services). + See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) + for more details. + type: string + RoleSid: + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + to assign to the member. The default roles are those specified + on the [Service](https://www.twilio.com/docs/chat/api/services). + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + required: + - Identity + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.member' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id003 + - sid + - identity + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: + delete: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to delete the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the message belongs to. Can be the Channel's `sid` or `unique_name`. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The Twilio-provided string that uniquely identifies the Member + resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Users joined to specific channels + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to fetch the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the member to fetch belongs to. Can be the Channel resource's `sid` or `unique_name` + value. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The Twilio-provided string that uniquely identifies the Member + resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.member' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to update the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the member to update belongs to. Can be the Channel resource's `sid` or + `unique_name`. + in: path + name: ChannelSid + required: true + schema: + type: string + - description: The Twilio-provided string that uniquely identifies the Member + resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + LastConsumedMessageIndex: + description: The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) + that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels). + nullable: true + type: integer + RoleSid: + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + to assign to the member. The default roles are those specified + on the [Service](https://www.twilio.com/docs/chat/api/services). + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.member' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: + description: Individual chat messages + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the message to read belongs to. Can be the Channel's `sid` or `unique_name`. + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: 'The sort order of the returned messages. Can be: `asc` (ascending) + or `desc` (descending) with `asc` as the default.' + in: query + name: Order + schema: + enum: + - asc + - desc + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + messages: + items: + $ref: '#/components/schemas/chat.v1.service.channel.message' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to create the resource under. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the new resource belongs to. Can be the Channel resource's `sid` or `unique_name`. + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: A valid JSON string that contains application-specific + data. + type: string + Body: + description: The message to send to the channel. Can also be an + empty string or `null`, which sets the value as an empty string. + You can send structured data in the body by serializing it as + a string. + type: string + From: + description: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) + of the new message's author. The default value is `system`. + type: string + required: + - Body + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.message' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id004 + - sid + - from + - to + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: + delete: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to delete the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the message to delete belongs to. Can be the Channel resource's `sid` or + `unique_name`. + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Message + resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Individual chat messages + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to fetch the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the message to fetch belongs to. Can be the Channel's `sid` or `unique_name`. + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Message + resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.message' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to update the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the message belongs to. Can be the Channel's `sid` or `unique_name`. + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Message + resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: A valid JSON string that contains application-specific + data. + type: string + Body: + description: The message to send to the channel. Can also be an + empty string or `null`, which sets the value as an empty string. + You can send structured data in the body by serializing it as + a string. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel.message' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /v1/Services/{ServiceSid}/Channels/{Sid}: + delete: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to delete the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Channel + resource to delete. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Channels represent chat rooms + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to fetch the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Channel + resource to fetch. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to update the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Channel + resource to update. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: A valid JSON string that contains application-specific + data. + type: string + FriendlyName: + description: A descriptive string that you create to describe the + resource. It can be up to 64 characters long. + type: string + UniqueName: + description: An application-defined string that uniquely identifies + the resource. It can be used to address the resource in place + of the resource's `sid` in the URL. This value must be 64 characters + or less in length and be unique within the Service. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.channel' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id005 + x-path-type: instance + /v1/Services/{ServiceSid}/Roles: + description: Roles determining user or member permissions + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + roles: + items: + $ref: '#/components/schemas/chat.v1.service.role' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to create the resource under. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: A descriptive string that you create to describe the + new resource. It can be up to 64 characters long. + type: string + Permission: + description: A permission that you grant to the new role. Only one + permission can be granted per parameter. To assign more than one + permission, repeat this parameter for each permission value. The + values for this parameter depend on the role's `type` and are + described in the documentation. + items: + type: string + type: array + Type: + description: 'The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) + roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) + roles.' + enum: + - channel + - deployment + type: string + required: + - FriendlyName + - Type + - Permission + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.role' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id006 + - sid + - friendly_name + - type + x-path-type: list + /v1/Services/{ServiceSid}/Roles/{Sid}: + delete: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to delete the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Role + resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Roles determining user or member permissions + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to fetch the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Role + resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.role' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to update the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the Role + resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Permission: + description: A permission that you grant to the role. Only one permission + can be granted per parameter. To assign more than one permission, + repeat this parameter for each permission value. The values for + this parameter depend on the role's `type` and are described in + the documentation. + items: + type: string + type: array + required: + - Permission + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.role' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id006 + x-path-type: instance + /v1/Services/{ServiceSid}/Users: + description: Unique chat users within a chat service + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/chat.v1.service.user' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to create the resource under. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: A valid JSON string that contains application-specific + data. + type: string + FriendlyName: + description: A descriptive string that you create to describe the + new resource. This value is often used for display purposes. + type: string + Identity: + description: The `identity` value that uniquely identifies the new + resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) + within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). + This value is often a username or email address. See the Identity + documentation for more details. + type: string + RoleSid: + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + assigned to the new User. + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + required: + - Identity + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.user' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: &id007 + - sid + - friendly_name + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Users/{Sid}: + delete: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to delete the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the User + resource to delete. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Unique chat users within a chat service + get: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to fetch the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the User + resource to fetch. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.user' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to update the resource from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The Twilio-provided string that uniquely identifies the User + resource to update. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: A valid JSON string that contains application-specific + data. + type: string + FriendlyName: + description: A descriptive string that you create to describe the + resource. It is often used for display purposes. + type: string + RoleSid: + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + assigned to this user. + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service.user' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id007 + x-path-type: instance + /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: + description: 'TODO: Resource-level docs' + get: + description: List all Channels for a given User. + parameters: + - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + to read the resources from. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: The SID of the [User](https://www.twilio.com/docs/api/chat/rest/users) + to read the User Channel resources from. + in: path + name: UserSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + channels: + items: + $ref: '#/components/schemas/chat.v1.service.user.user_channel' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: + - channel_sid + - status + x-path-type: list + /v1/Services/{Sid}: + delete: + description: '' + parameters: + - description: The Twilio-provided string that uniquely identifies the Service + resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: Top level scope for all chat resources + get: + description: '' + parameters: + - description: The Twilio-provided string that uniquely identifies the Service + resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: The Twilio-provided string that uniquely identifies the Service + resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ConsumptionReportInterval: + description: DEPRECATED. The interval in seconds between consumption + reports submission batches from client endpoints. + type: integer + DefaultChannelCreatorRoleSid: + description: The channel role assigned to a channel creator when + they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) + for more details. + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + DefaultChannelRoleSid: + description: The channel role assigned to users when they are added + to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) + for more details. + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + DefaultServiceRoleSid: + description: The service role assigned to users when they are added + to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) + for more details. + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: A descriptive string that you create to describe the + resource. It can be up to 64 characters long. + type: string + Limits.ChannelMembers: + description: The maximum number of Members that can be added to + Channels within this Service. Can be up to 1,000. + type: integer + Limits.UserChannels: + description: The maximum number of Channels Users can be a Member + of within this Service. Can be up to 1,000. + type: integer + Notifications.AddedToChannel.Enabled: + description: 'Whether to send a notification when a member is added + to a channel. Can be: `true` or `false` and the default is `false`.' + type: boolean + Notifications.AddedToChannel.Template: + description: The template to use to create the notification text + displayed when a member is added to a channel and `notifications.added_to_channel.enabled` + is `true`. + type: string + Notifications.InvitedToChannel.Enabled: + description: 'Whether to send a notification when a user is invited + to a channel. Can be: `true` or `false` and the default is `false`.' + type: boolean + Notifications.InvitedToChannel.Template: + description: The template to use to create the notification text + displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` + is `true`. + type: string + Notifications.NewMessage.Enabled: + description: 'Whether to send a notification when a new message + is added to a channel. Can be: `true` or `false` and the default + is `false`.' + type: boolean + Notifications.NewMessage.Template: + description: The template to use to create the notification text + displayed when a new message is added to a channel and `notifications.new_message.enabled` + is `true`. + type: string + Notifications.RemovedFromChannel.Enabled: + description: 'Whether to send a notification to a user when they + are removed from a channel. Can be: `true` or `false` and the + default is `false`.' + type: boolean + Notifications.RemovedFromChannel.Template: + description: The template to use to create the notification text + displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` + is `true`. + type: string + PostWebhookUrl: + description: The URL for post-event webhooks, which are called by + using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) + for more details. + format: uri + type: string + PreWebhookUrl: + description: The URL for pre-event webhooks, which are called by + using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) + for more details. + format: uri + type: string + ReachabilityEnabled: + description: Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) + for this Service instance. The default is `false`. + type: boolean + ReadStatusEnabled: + description: Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) + feature. The default is `true`. + type: boolean + TypingIndicatorTimeout: + 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. + type: integer + WebhookFilters: + description: The list of WebHook events that are enabled for this + Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details. + items: + type: string + type: array + WebhookMethod: + description: 'The HTTP method to use for calls to the `pre_webhook_url` + and `post_webhook_url` webhooks. Can be: `POST` or `GET` and + the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details.' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelAdd.Method: + description: The HTTP method to use when calling the `webhooks.on_channel_add.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelAdd.Url: + description: The URL of the webhook to call in response to the `on_channel_add` + event using the `webhooks.on_channel_add.method` HTTP method. + format: uri + type: string + Webhooks.OnChannelAdded.Method: + description: The URL of the webhook to call in response to the `on_channel_added` + event`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelAdded.Url: + description: The URL of the webhook to call in response to the `on_channel_added` + event using the `webhooks.on_channel_added.method` HTTP method. + format: uri + type: string + Webhooks.OnChannelDestroy.Method: + description: The HTTP method to use when calling the `webhooks.on_channel_destroy.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelDestroy.Url: + description: The URL of the webhook to call in response to the `on_channel_destroy` + event using the `webhooks.on_channel_destroy.method` HTTP method. + format: uri + type: string + Webhooks.OnChannelDestroyed.Method: + description: The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelDestroyed.Url: + description: The URL of the webhook to call in response to the `on_channel_added` + event using the `webhooks.on_channel_destroyed.method` HTTP method. + format: uri + type: string + Webhooks.OnChannelUpdate.Method: + description: The HTTP method to use when calling the `webhooks.on_channel_update.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelUpdate.Url: + description: The URL of the webhook to call in response to the `on_channel_update` + event using the `webhooks.on_channel_update.method` HTTP method. + format: uri + type: string + Webhooks.OnChannelUpdated.Method: + description: The HTTP method to use when calling the `webhooks.on_channel_updated.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelUpdated.Url: + description: The URL of the webhook to call in response to the `on_channel_updated` + event using the `webhooks.on_channel_updated.method` HTTP method. + format: uri + type: string + Webhooks.OnMemberAdd.Method: + description: The HTTP method to use when calling the `webhooks.on_member_add.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberAdd.Url: + description: The URL of the webhook to call in response to the `on_member_add` + event using the `webhooks.on_member_add.method` HTTP method. + format: uri + type: string + Webhooks.OnMemberAdded.Method: + description: The HTTP method to use when calling the `webhooks.on_channel_updated.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberAdded.Url: + description: The URL of the webhook to call in response to the `on_channel_updated` + event using the `webhooks.on_channel_updated.method` HTTP method. + format: uri + type: string + Webhooks.OnMemberRemove.Method: + description: The HTTP method to use when calling the `webhooks.on_member_remove.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberRemove.Url: + description: The URL of the webhook to call in response to the `on_member_remove` + event using the `webhooks.on_member_remove.method` HTTP method. + format: uri + type: string + Webhooks.OnMemberRemoved.Method: + description: The HTTP method to use when calling the `webhooks.on_member_removed.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberRemoved.Url: + description: The URL of the webhook to call in response to the `on_member_removed` + event using the `webhooks.on_member_removed.method` HTTP method. + format: uri + type: string + Webhooks.OnMessageRemove.Method: + description: The HTTP method to use when calling the `webhooks.on_message_remove.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageRemove.Url: + description: The URL of the webhook to call in response to the `on_message_remove` + event using the `webhooks.on_message_remove.method` HTTP method. + format: uri + type: string + Webhooks.OnMessageRemoved.Method: + description: The HTTP method to use when calling the `webhooks.on_message_removed.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageRemoved.Url: + description: The URL of the webhook to call in response to the `on_message_removed` + event using the `webhooks.on_message_removed.method` HTTP method. + format: uri + type: string + Webhooks.OnMessageSend.Method: + description: The HTTP method to use when calling the `webhooks.on_message_send.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageSend.Url: + description: The URL of the webhook to call in response to the `on_message_send` + event using the `webhooks.on_message_send.method` HTTP method. + format: uri + type: string + Webhooks.OnMessageSent.Method: + description: The URL of the webhook to call in response to the `on_message_sent` + event`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageSent.Url: + description: The URL of the webhook to call in response to the `on_message_sent` + event using the `webhooks.on_message_sent.method` HTTP method. + format: uri + type: string + Webhooks.OnMessageUpdate.Method: + description: The HTTP method to use when calling the `webhooks.on_message_update.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageUpdate.Url: + description: The URL of the webhook to call in response to the `on_message_update` + event using the `webhooks.on_message_update.method` HTTP method. + format: uri + type: string + Webhooks.OnMessageUpdated.Method: + description: The HTTP method to use when calling the `webhooks.on_message_updated.url`. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageUpdated.Url: + description: The URL of the webhook to call in response to the `on_message_updated` + event using the `webhooks.on_message_updated.method` HTTP method. + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/chat.v1.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://chat.twilio.com + x-default-output-properties: *id008 + x-path-type: instance +tags: +- description: This product is Generally Available. + name: GA diff --git a/spec/yaml/twilio_chat.yaml b/spec/yaml/twilio_chat_v2.yaml similarity index 57% rename from spec/yaml/twilio_chat.yaml rename to spec/yaml/twilio_chat_v2.yaml index f12bc5bf..1fb2df88 100644 --- a/spec/yaml/twilio_chat.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -1,6 +1,6 @@ components: schemas: - chat.v1.credential: + chat.v2.credential: properties: account_sid: maxLength: 34 @@ -32,7 +32,7 @@ components: format: uri type: string type: object - chat.v1.service: + chat.v2.service: properties: account_sid: maxLength: 34 @@ -68,10 +68,16 @@ components: type: object links: type: object + media: + type: object notifications: type: object + post_webhook_retry_count: + type: integer post_webhook_url: type: string + pre_webhook_retry_count: + type: integer pre_webhook_url: type: string reachability_enabled: @@ -94,19 +100,24 @@ components: type: array webhook_method: type: string - webhooks: - type: object type: object - chat.v1.service.channel: + chat.v2.service.binding: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - attributes: + binding_type: + enum: + - gcm + - apn + - fcm type: string - created_by: + credential_sid: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ type: string date_created: format: date-time @@ -114,14 +125,16 @@ components: date_updated: format: date-time type: string - friendly_name: + endpoint: + type: string + identity: type: string links: type: object - members_count: - type: integer - messages_count: - type: integer + message_types: + items: + type: string + type: array service_sid: maxLength: 34 minLength: 34 @@ -130,30 +143,20 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - type: - enum: - - public - - private - type: string - unique_name: + pattern: ^BS[0-9a-fA-F]{32}$ type: string url: format: uri type: string type: object - chat.v1.service.channel.invite: + chat.v2.service.channel: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ + attributes: type: string created_by: type: string @@ -163,13 +166,14 @@ components: date_updated: format: date-time type: string - identity: - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ + friendly_name: type: string + links: + type: object + members_count: + type: integer + messages_count: + type: integer service_sid: maxLength: 34 minLength: 34 @@ -178,13 +182,20 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + type: + enum: + - public + - private + type: string + unique_name: type: string url: format: uri type: string type: object - chat.v1.service.channel.member: + chat.v2.service.channel.channel_webhook: properties: account_sid: maxLength: 34 @@ -196,25 +207,14 @@ components: minLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ type: string + configuration: + type: object date_created: format: date-time type: string date_updated: format: date-time type: string - identity: - type: string - last_consumed_message_index: - nullable: true - type: integer - last_consumption_timestamp: - format: date-time - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string service_sid: maxLength: 34 minLength: 34 @@ -223,78 +223,41 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ + pattern: ^WH[0-9a-fA-F]{32}$ + type: string + type: type: string url: format: uri type: string type: object - chat.v1.service.channel.message: + chat.v2.service.channel.invite: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - attributes: - type: string - body: - type: string channel_sid: maxLength: 34 minLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ type: string + created_by: + type: string date_created: format: date-time type: string date_updated: format: date-time type: string - from: - type: string - index: - type: integer - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - to: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - url: - format: uri + identity: type: string - was_edited: - type: boolean - type: object - chat.v1.service.role: - properties: - account_sid: + role_sid: maxLength: 34 minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: + pattern: ^RL[0-9a-fA-F]{32}$ type: string - permissions: - items: - type: string - type: array service_sid: maxLength: 34 minLength: 34 @@ -303,18 +266,13 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: - enum: - - channel - - deployment + pattern: ^IN[0-9a-fA-F]{32}$ type: string url: format: uri type: string type: object - chat.v1.service.user: + chat.v2.service.channel.member: properties: account_sid: maxLength: 34 @@ -323,24 +281,25 @@ components: type: string attributes: type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string date_created: format: date-time type: string date_updated: format: date-time type: string - friendly_name: - type: string identity: type: string - is_notifiable: - type: boolean - is_online: - type: boolean - joined_channels_count: + last_consumed_message_index: + nullable: true type: integer - links: - type: object + last_consumption_timestamp: + format: date-time + type: string role_sid: maxLength: 34 minLength: 34 @@ -354,55 +313,27 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ + pattern: ^MB[0-9a-fA-F]{32}$ type: string url: format: uri type: string type: object - chat.v1.service.user.user_channel: + chat.v2.service.channel.message: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - last_consumed_message_index: - nullable: true - type: integer - links: - type: object - member_sid: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + attributes: type: string - status: - enum: - - joined - - invited - - not_participating + body: type: string - unread_messages_count: - nullable: true - type: integer - type: object - chat.v2.credential: - properties: - account_sid: + channel_sid: maxLength: 34 minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^CH[0-9a-fA-F]{32}$ type: string date_created: format: date-time @@ -410,3024 +341,240 @@ components: date_updated: format: date-time type: string - friendly_name: - type: string - sandbox: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - type: - enum: - - gcm - - apn - - fcm - type: string - url: - format: uri - type: string - type: object - chat.v2.service: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + from: type: string - consumption_report_interval: + index: type: integer - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - default_channel_creator_role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - default_channel_role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - default_service_role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - friendly_name: + last_updated_by: type: string - limits: - type: object - links: - type: object media: type: object - notifications: - type: object - post_webhook_retry_count: - type: integer - post_webhook_url: - type: string - pre_webhook_retry_count: - type: integer - pre_webhook_url: - type: string - reachability_enabled: - type: boolean - read_status_enabled: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - typing_indicator_timeout: - type: integer - url: - format: uri - type: string - webhook_filters: - items: - type: string - type: array - webhook_method: - type: string - type: object - chat.v2.service.binding: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - binding_type: - enum: - - gcm - - apn - - fcm - type: string - credential_sid: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - endpoint: - type: string - identity: - type: string - links: - type: object - message_types: - items: - type: string - type: array - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^BS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - chat.v2.service.channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - members_count: - type: integer - messages_count: - type: integer - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - type: - enum: - - public - - private - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - chat.v2.service.channel.channel_webhook: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - configuration: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^WH[0-9a-fA-F]{32}$ - type: string - type: - type: string - url: - format: uri - type: string - type: object - chat.v2.service.channel.invite: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - identity: - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - chat.v2.service.channel.member: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - identity: - type: string - last_consumed_message_index: - nullable: true - type: integer - last_consumption_timestamp: - format: date-time - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - chat.v2.service.channel.message: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - body: - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - from: - type: string - index: - type: integer - last_updated_by: - type: string - media: - type: object - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - to: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - type: - type: string - url: - format: uri - type: string - was_edited: - type: boolean - type: object - chat.v2.service.role: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - permissions: - items: - type: string - type: array - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: - enum: - - channel - - deployment - type: string - url: - format: uri - type: string - type: object - chat.v2.service.user: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - identity: - type: string - is_notifiable: - type: boolean - is_online: - type: boolean - joined_channels_count: - type: integer - links: - type: object - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - chat.v2.service.user.user_binding: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - binding_type: - enum: - - gcm - - apn - - fcm - type: string - credential_sid: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - endpoint: - type: string - identity: - type: string - message_types: - items: - type: string - type: array - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^BS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - user_sid: - maxLength: 34 - minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - type: string - type: object - chat.v2.service.user.user_channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - last_consumed_message_index: - nullable: true - type: integer - links: - type: object - member_sid: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - notification_level: - enum: - - default - - muted - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - status: - enum: - - joined - - invited - - not_participating - type: string - unread_messages_count: - nullable: true - type: integer - url: - format: uri - type: string - user_sid: - maxLength: 34 - minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Chat - version: 1.3.0 -openapi: 3.0.1 -paths: - /v1/Credentials: - description: Credentials for push notifications channels - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - credentials: - items: - $ref: '#/components/schemas/chat.v1.credential' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ApiKey: - description: '[GCM only] The API key for the project that was obtained - from the Google Developer console for your GCM Service application - credential.' - type: string - Certificate: - description: "[APN only] The URL encoded representation of the certificate.\ - \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n\ - -----END CERTIFICATE-----`" - type: string - FriendlyName: - description: A descriptive string that you create to describe the - new resource. It can be up to 64 characters long. - type: string - PrivateKey: - description: '[APN only] The URL encoded representation of the private - key. For example, - - `-----BEGIN RSA PRIVATE KEY----- - - MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. - - -----END RSA PRIVATE KEY-----`' - type: string - Sandbox: - description: '[APN only] Whether to send the credential to sandbox - APNs. Can be `true` to send to sandbox APNs or `false` to send - to production.' - type: boolean - Secret: - description: '[FCM only] The **Server key** of your project from - the Firebase console, found under Settings / Cloud messaging.' - type: string - Type: - description: 'The type of push-notification service the credential - is for. Can be: `gcm`, `fcm`, or `apn`.' - enum: - - gcm - - apn - - fcm - type: string - required: - - Type - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.credential' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id001 - - sid - - friendly_name - - type - x-path-type: list - /v1/Credentials/{Sid}: - delete: - description: '' - parameters: - - description: The Twilio-provided string that uniquely identifies the Credential - resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Credentials for push notifications channels - get: - description: '' - parameters: - - description: The Twilio-provided string that uniquely identifies the Credential - resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.credential' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The Twilio-provided string that uniquely identifies the Credential - resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ApiKey: - description: '[GCM only] The API key for the project that was obtained - from the Google Developer console for your GCM Service application - credential.' - type: string - Certificate: - description: "[APN only] The URL encoded representation of the certificate.\ - \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n\ - -----END CERTIFICATE-----`" - type: string - FriendlyName: - description: A descriptive string that you create to describe the - resource. It can be up to 64 characters long. - type: string - PrivateKey: - description: '[APN only] The URL encoded representation of the private - key. For example, - - `-----BEGIN RSA PRIVATE KEY----- - - MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. - - -----END RSA PRIVATE KEY-----`' - type: string - Sandbox: - description: '[APN only] Whether to send the credential to sandbox - APNs. Can be `true` to send to sandbox APNs or `false` to send - to production.' - type: boolean - Secret: - description: '[FCM only] The **Server key** of your project from - the Firebase console, found under Settings / Cloud messaging.' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.credential' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /v1/Services: - description: Top level scope for all chat resources - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - services: - items: - $ref: '#/components/schemas/chat.v1.service' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: A descriptive string that you create to describe the - resource. It can be up to 64 characters long. - type: string - required: - - FriendlyName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id008 - - sid - - friendly_name - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels: - description: Channels represent chat rooms - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: 'The visibility of the Channels to read. Can be: `public` or - `private` and defaults to `public`.' - in: query - name: Type - schema: - items: - enum: - - public - - private - type: string - type: array - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - channels: - items: - $ref: '#/components/schemas/chat.v1.service.channel' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to create the resource under. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: A valid JSON string that contains application-specific - data. - type: string - FriendlyName: - description: A descriptive string that you create to describe the - new resource. It can be up to 64 characters long. - type: string - Type: - description: 'The visibility of the channel. Can be: `public` or - `private` and defaults to `public`.' - enum: - - public - - private - type: string - UniqueName: - description: An application-defined string that uniquely identifies - the resource. It can be used to address the resource in place - of the resource's `sid` in the URL. This value must be 64 characters - or less in length and be unique within the Service. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id005 - - sid - - unique_name - - friendly_name - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: - description: Pending invitations to users to become channel members - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the resources to read belong to. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s - `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) - for more details. - in: query - name: Identity - schema: - items: - type: string - type: array - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - invites: - items: - $ref: '#/components/schemas/chat.v1.service.channel.invite' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to create the resource under. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the new resource belongs to. - in: path - name: ChannelSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Identity: - description: The `identity` value that uniquely identifies the new - resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) - within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). - See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) - for more info. - type: string - RoleSid: - description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) - assigned to the new member. - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - required: - - Identity - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.invite' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id002 - - sid - - identity - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: - delete: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to delete the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the resource to delete belongs to. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The Twilio-provided string that uniquely identifies the Invite - resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Pending invitations to users to become channel members - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to fetch the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the resource to fetch belongs to. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The Twilio-provided string that uniquely identifies the Invite - resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.invite' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: - description: Users joined to specific channels - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the members to read belong to. Can be the Channel resource's `sid` or `unique_name` - value. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s - `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) - for more details. - in: query - name: Identity - schema: - items: - type: string - type: array - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - members: - items: - $ref: '#/components/schemas/chat.v1.service.channel.member' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to create the resource under. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the new member belongs to. Can be the Channel resource's `sid` or `unique_name`. - in: path - name: ChannelSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Identity: - description: The `identity` value that uniquely identifies the new - resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) - within the [Service](https://www.twilio.com/docs/api/chat/rest/services). - See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) - for more details. - type: string - RoleSid: - description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) - to assign to the member. The default roles are those specified - on the [Service](https://www.twilio.com/docs/chat/api/services). - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - required: - - Identity - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.member' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id003 - - sid - - identity - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: - delete: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to delete the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the message belongs to. Can be the Channel's `sid` or `unique_name`. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The Twilio-provided string that uniquely identifies the Member - resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Users joined to specific channels - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to fetch the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the member to fetch belongs to. Can be the Channel resource's `sid` or `unique_name` - value. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The Twilio-provided string that uniquely identifies the Member - resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.member' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to update the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the member to update belongs to. Can be the Channel resource's `sid` or - `unique_name`. - in: path - name: ChannelSid - required: true - schema: - type: string - - description: The Twilio-provided string that uniquely identifies the Member - resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - LastConsumedMessageIndex: - description: The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) - that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels). - nullable: true - type: integer - RoleSid: - description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) - to assign to the member. The default roles are those specified - on the [Service](https://www.twilio.com/docs/chat/api/services). - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.member' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: - description: Individual chat messages - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the message to read belongs to. Can be the Channel's `sid` or `unique_name`. - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: 'The sort order of the returned messages. Can be: `asc` (ascending) - or `desc` (descending) with `asc` as the default.' - in: query - name: Order - schema: - enum: - - asc - - desc - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - messages: - items: - $ref: '#/components/schemas/chat.v1.service.channel.message' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to create the resource under. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the new resource belongs to. Can be the Channel resource's `sid` or `unique_name`. - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: A valid JSON string that contains application-specific - data. - type: string - Body: - description: The message to send to the channel. Can also be an - empty string or `null`, which sets the value as an empty string. - You can send structured data in the body by serializing it as - a string. - type: string - From: - description: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) - of the new message's author. The default value is `system`. - type: string - required: - - Body - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.message' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id004 - - sid - - from - - to - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: - delete: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to delete the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the message to delete belongs to. Can be the Channel resource's `sid` or - `unique_name`. - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Message - resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Individual chat messages - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to fetch the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the message to fetch belongs to. Can be the Channel's `sid` or `unique_name`. - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Message - resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.message' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to update the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) - the message belongs to. Can be the Channel's `sid` or `unique_name`. - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Message - resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: A valid JSON string that contains application-specific - data. - type: string - Body: - description: The message to send to the channel. Can also be an - empty string or `null`, which sets the value as an empty string. - You can send structured data in the body by serializing it as - a string. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel.message' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /v1/Services/{ServiceSid}/Channels/{Sid}: - delete: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to delete the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Channel - resource to delete. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Channels represent chat rooms - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to fetch the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Channel - resource to fetch. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to update the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Channel - resource to update. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: A valid JSON string that contains application-specific - data. - type: string - FriendlyName: - description: A descriptive string that you create to describe the - resource. It can be up to 64 characters long. - type: string - UniqueName: - description: An application-defined string that uniquely identifies - the resource. It can be used to address the resource in place - of the resource's `sid` in the URL. This value must be 64 characters - or less in length and be unique within the Service. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.channel' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id005 - x-path-type: instance - /v1/Services/{ServiceSid}/Roles: - description: Roles determining user or member permissions - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - roles: - items: - $ref: '#/components/schemas/chat.v1.service.role' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to create the resource under. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: A descriptive string that you create to describe the - new resource. It can be up to 64 characters long. - type: string - Permission: - description: A permission that you grant to the new role. Only one - permission can be granted per parameter. To assign more than one - permission, repeat this parameter for each permission value. The - values for this parameter depend on the role's `type` and are - described in the documentation. - items: - type: string - type: array - Type: - description: 'The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) - roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) - roles.' - enum: - - channel - - deployment - type: string - required: - - FriendlyName - - Type - - Permission - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.role' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id006 - - sid - - friendly_name - - type - x-path-type: list - /v1/Services/{ServiceSid}/Roles/{Sid}: - delete: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to delete the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Role - resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Roles determining user or member permissions - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to fetch the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Role - resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.role' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to update the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the Role - resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Permission: - description: A permission that you grant to the role. Only one permission - can be granted per parameter. To assign more than one permission, - repeat this parameter for each permission value. The values for - this parameter depend on the role's `type` and are described in - the documentation. - items: - type: string - type: array - required: - - Permission - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.role' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id006 - x-path-type: instance - /v1/Services/{ServiceSid}/Users: - description: Unique chat users within a chat service - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/chat.v1.service.user' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to create the resource under. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: A valid JSON string that contains application-specific - data. - type: string - FriendlyName: - description: A descriptive string that you create to describe the - new resource. This value is often used for display purposes. - type: string - Identity: - description: The `identity` value that uniquely identifies the new - resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) - within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). - This value is often a username or email address. See the Identity - documentation for more details. - type: string - RoleSid: - description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) - assigned to the new User. - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - required: - - Identity - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.user' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: &id007 - - sid - - friendly_name - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Users/{Sid}: - delete: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to delete the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the User - resource to delete. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Unique chat users within a chat service - get: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to fetch the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the User - resource to fetch. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.user' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to update the resource from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The Twilio-provided string that uniquely identifies the User - resource to update. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: A valid JSON string that contains application-specific - data. - type: string - FriendlyName: - description: A descriptive string that you create to describe the - resource. It is often used for display purposes. - type: string - RoleSid: - description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) - assigned to this user. - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service.user' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id007 - x-path-type: instance - /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: - description: 'TODO: Resource-level docs' - get: - description: List all Channels for a given User. - parameters: - - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) - to read the resources from. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: The SID of the [User](https://www.twilio.com/docs/api/chat/rest/users) - to read the User Channel resources from. - in: path - name: UserSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - channels: - items: - $ref: '#/components/schemas/chat.v1.service.user.user_channel' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: - - channel_sid - - status - x-path-type: list - /v1/Services/{Sid}: - delete: - description: '' - parameters: - - description: The Twilio-provided string that uniquely identifies the Service - resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: Top level scope for all chat resources - get: - description: '' - parameters: - - description: The Twilio-provided string that uniquely identifies the Service - resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: The Twilio-provided string that uniquely identifies the Service - resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ConsumptionReportInterval: - description: DEPRECATED. The interval in seconds between consumption - reports submission batches from client endpoints. - type: integer - DefaultChannelCreatorRoleSid: - description: The channel role assigned to a channel creator when - they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) - for more details. - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - DefaultChannelRoleSid: - description: The channel role assigned to users when they are added - to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) - for more details. - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - DefaultServiceRoleSid: - description: The service role assigned to users when they are added - to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) - for more details. - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: A descriptive string that you create to describe the - resource. It can be up to 64 characters long. - type: string - Limits.ChannelMembers: - description: The maximum number of Members that can be added to - Channels within this Service. Can be up to 1,000. - type: integer - Limits.UserChannels: - description: The maximum number of Channels Users can be a Member - of within this Service. Can be up to 1,000. - type: integer - Notifications.AddedToChannel.Enabled: - description: 'Whether to send a notification when a member is added - to a channel. Can be: `true` or `false` and the default is `false`.' - type: boolean - Notifications.AddedToChannel.Template: - description: The template to use to create the notification text - displayed when a member is added to a channel and `notifications.added_to_channel.enabled` - is `true`. - type: string - Notifications.InvitedToChannel.Enabled: - description: 'Whether to send a notification when a user is invited - to a channel. Can be: `true` or `false` and the default is `false`.' - type: boolean - Notifications.InvitedToChannel.Template: - description: The template to use to create the notification text - displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` - is `true`. - type: string - Notifications.NewMessage.Enabled: - description: 'Whether to send a notification when a new message - is added to a channel. Can be: `true` or `false` and the default - is `false`.' - type: boolean - Notifications.NewMessage.Template: - description: The template to use to create the notification text - displayed when a new message is added to a channel and `notifications.new_message.enabled` - is `true`. - type: string - Notifications.RemovedFromChannel.Enabled: - description: 'Whether to send a notification to a user when they - are removed from a channel. Can be: `true` or `false` and the - default is `false`.' - type: boolean - Notifications.RemovedFromChannel.Template: - description: The template to use to create the notification text - displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` - is `true`. - type: string - PostWebhookUrl: - description: The URL for post-event webhooks, which are called by - using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) - for more details. - format: uri - type: string - PreWebhookUrl: - description: The URL for pre-event webhooks, which are called by - using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) - for more details. - format: uri - type: string - ReachabilityEnabled: - description: Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) - for this Service instance. The default is `false`. - type: boolean - ReadStatusEnabled: - description: Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) - feature. The default is `true`. - type: boolean - TypingIndicatorTimeout: - 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. - type: integer - WebhookFilters: - description: The list of WebHook events that are enabled for this - Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) - for more details. - items: - type: string - type: array - WebhookMethod: - description: 'The HTTP method to use for calls to the `pre_webhook_url` - and `post_webhook_url` webhooks. Can be: `POST` or `GET` and - the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) - for more details.' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelAdd.Method: - description: The HTTP method to use when calling the `webhooks.on_channel_add.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelAdd.Url: - description: The URL of the webhook to call in response to the `on_channel_add` - event using the `webhooks.on_channel_add.method` HTTP method. - format: uri - type: string - Webhooks.OnChannelAdded.Method: - description: The URL of the webhook to call in response to the `on_channel_added` - event`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelAdded.Url: - description: The URL of the webhook to call in response to the `on_channel_added` - event using the `webhooks.on_channel_added.method` HTTP method. - format: uri - type: string - Webhooks.OnChannelDestroy.Method: - description: The HTTP method to use when calling the `webhooks.on_channel_destroy.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelDestroy.Url: - description: The URL of the webhook to call in response to the `on_channel_destroy` - event using the `webhooks.on_channel_destroy.method` HTTP method. - format: uri - type: string - Webhooks.OnChannelDestroyed.Method: - description: The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelDestroyed.Url: - description: The URL of the webhook to call in response to the `on_channel_added` - event using the `webhooks.on_channel_destroyed.method` HTTP method. - format: uri - type: string - Webhooks.OnChannelUpdate.Method: - description: The HTTP method to use when calling the `webhooks.on_channel_update.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelUpdate.Url: - description: The URL of the webhook to call in response to the `on_channel_update` - event using the `webhooks.on_channel_update.method` HTTP method. - format: uri - type: string - Webhooks.OnChannelUpdated.Method: - description: The HTTP method to use when calling the `webhooks.on_channel_updated.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelUpdated.Url: - description: The URL of the webhook to call in response to the `on_channel_updated` - event using the `webhooks.on_channel_updated.method` HTTP method. - format: uri - type: string - Webhooks.OnMemberAdd.Method: - description: The HTTP method to use when calling the `webhooks.on_member_add.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberAdd.Url: - description: The URL of the webhook to call in response to the `on_member_add` - event using the `webhooks.on_member_add.method` HTTP method. - format: uri - type: string - Webhooks.OnMemberAdded.Method: - description: The HTTP method to use when calling the `webhooks.on_channel_updated.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberAdded.Url: - description: The URL of the webhook to call in response to the `on_channel_updated` - event using the `webhooks.on_channel_updated.method` HTTP method. - format: uri - type: string - Webhooks.OnMemberRemove.Method: - description: The HTTP method to use when calling the `webhooks.on_member_remove.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberRemove.Url: - description: The URL of the webhook to call in response to the `on_member_remove` - event using the `webhooks.on_member_remove.method` HTTP method. - format: uri - type: string - Webhooks.OnMemberRemoved.Method: - description: The HTTP method to use when calling the `webhooks.on_member_removed.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberRemoved.Url: - description: The URL of the webhook to call in response to the `on_member_removed` - event using the `webhooks.on_member_removed.method` HTTP method. - format: uri - type: string - Webhooks.OnMessageRemove.Method: - description: The HTTP method to use when calling the `webhooks.on_message_remove.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageRemove.Url: - description: The URL of the webhook to call in response to the `on_message_remove` - event using the `webhooks.on_message_remove.method` HTTP method. - format: uri - type: string - Webhooks.OnMessageRemoved.Method: - description: The HTTP method to use when calling the `webhooks.on_message_removed.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageRemoved.Url: - description: The URL of the webhook to call in response to the `on_message_removed` - event using the `webhooks.on_message_removed.method` HTTP method. - format: uri - type: string - Webhooks.OnMessageSend.Method: - description: The HTTP method to use when calling the `webhooks.on_message_send.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageSend.Url: - description: The URL of the webhook to call in response to the `on_message_send` - event using the `webhooks.on_message_send.method` HTTP method. - format: uri - type: string - Webhooks.OnMessageSent.Method: - description: The URL of the webhook to call in response to the `on_message_sent` - event`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageSent.Url: - description: The URL of the webhook to call in response to the `on_message_sent` - event using the `webhooks.on_message_sent.method` HTTP method. - format: uri - type: string - Webhooks.OnMessageUpdate.Method: - description: The HTTP method to use when calling the `webhooks.on_message_update.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageUpdate.Url: - description: The URL of the webhook to call in response to the `on_message_update` - event using the `webhooks.on_message_update.method` HTTP method. - format: uri - type: string - Webhooks.OnMessageUpdated.Method: - description: The HTTP method to use when calling the `webhooks.on_message_updated.url`. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageUpdated.Url: - description: The URL of the webhook to call in response to the `on_message_updated` - event using the `webhooks.on_message_updated.method` HTTP method. - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/chat.v1.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://chat.twilio.com - x-default-output-properties: *id008 - x-path-type: instance + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + to: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + type: + type: string + url: + format: uri + type: string + was_edited: + type: boolean + type: object + chat.v2.service.role: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + permissions: + items: + type: string + type: array + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: + enum: + - channel + - deployment + type: string + url: + format: uri + type: string + type: object + chat.v2.service.user: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + identity: + type: string + is_notifiable: + type: boolean + is_online: + type: boolean + joined_channels_count: + type: integer + links: + type: object + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + chat.v2.service.user.user_binding: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + binding_type: + enum: + - gcm + - apn + - fcm + type: string + credential_sid: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + endpoint: + type: string + identity: + type: string + message_types: + items: + type: string + type: array + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^BS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + user_sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + type: object + chat.v2.service.user.user_channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + last_consumed_message_index: + nullable: true + type: integer + links: + type: object + member_sid: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + notification_level: + enum: + - default + - muted + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + status: + enum: + - joined + - invited + - not_participating + type: string + unread_messages_count: + nullable: true + type: integer + url: + format: uri + type: string + user_sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Chat + version: 5.12.0 +openapi: 3.0.1 +paths: /v2/Credentials: description: Credentials for push notifications channels get: @@ -3542,7 +689,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id009 + x-default-output-properties: &id001 - sid - friendly_name - type @@ -3655,7 +802,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id009 + x-default-output-properties: *id001 x-path-type: instance /v2/Services: description: Top level scope for all chat resources @@ -3734,7 +881,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id020 + x-default-output-properties: &id012 - sid - friendly_name - date_created @@ -3823,7 +970,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id010 + x-default-output-properties: &id002 - sid - endpoint - identity @@ -3894,7 +1041,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id010 + x-default-output-properties: *id002 x-path-type: instance /v2/Services/{ServiceSid}/Channels: description: Channels represent chat rooms @@ -4048,7 +1195,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id015 + x-default-output-properties: &id007 - sid - unique_name - friendly_name @@ -4186,7 +1333,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id011 + x-default-output-properties: &id003 - sid - identity - date_created @@ -4273,7 +1420,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id011 + x-default-output-properties: *id003 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: description: Users joined to specific channels @@ -4450,7 +1597,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id012 + x-default-output-properties: &id004 - sid - identity - date_created @@ -4630,7 +1777,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id012 + x-default-output-properties: *id004 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: description: Individual chat messages @@ -4794,7 +1941,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id013 + x-default-output-properties: &id005 - sid - from - to @@ -4975,7 +2122,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id013 + x-default-output-properties: *id005 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: description: Webhooks for specific channels @@ -5135,7 +2282,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id014 + x-default-output-properties: &id006 - sid - configuration x-path-type: list @@ -5308,7 +2455,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id014 + x-default-output-properties: *id006 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{Sid}: delete: @@ -5456,7 +2603,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id015 + x-default-output-properties: *id007 x-path-type: instance /v2/Services/{ServiceSid}/Roles: description: Roles determining user or member permissions @@ -5574,7 +2721,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id016 + x-default-output-properties: &id008 - sid - friendly_name - type @@ -5697,7 +2844,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id016 + x-default-output-properties: *id008 x-path-type: instance /v2/Services/{ServiceSid}/Users: description: Unique chat users within a chat service @@ -5823,7 +2970,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id017 + x-default-output-properties: &id009 - sid - friendly_name - identity @@ -5951,7 +3098,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id017 + x-default-output-properties: *id009 x-path-type: instance /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: description: List of bindings for a given user @@ -6036,7 +3183,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id018 + x-default-output-properties: &id010 - sid - endpoint - identity @@ -6124,7 +3271,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id018 + x-default-output-properties: *id010 x-path-type: instance /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: description: List of channels for a given user @@ -6196,7 +3343,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: &id019 + x-default-output-properties: &id011 - channel_sid - status x-path-type: list @@ -6343,7 +3490,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id019 + x-default-output-properties: *id011 x-path-type: instance /v2/Services/{Sid}: delete: @@ -6589,7 +3736,7 @@ paths: - GA servers: - url: https://chat.twilio.com - x-default-output-properties: *id020 + x-default-output-properties: *id012 x-path-type: instance tags: - description: This product is Generally Available. diff --git a/spec/yaml/twilio_conversations.yaml b/spec/yaml/twilio_conversations_v1.yaml similarity index 99% rename from spec/yaml/twilio_conversations.yaml rename to spec/yaml/twilio_conversations_v1.yaml index e0364752..19f704ea 100644 --- a/spec/yaml/twilio_conversations.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -837,7 +837,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Conversations - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Configuration: diff --git a/spec/yaml/twilio_events.yaml b/spec/yaml/twilio_events_v1.yaml similarity index 99% rename from spec/yaml/twilio_events.yaml rename to spec/yaml/twilio_events_v1.yaml index b75238ea..00ffe8c3 100644 --- a/spec/yaml/twilio_events.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -161,7 +161,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Events - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Schemas/{Id}: diff --git a/spec/yaml/twilio_fax.yaml b/spec/yaml/twilio_fax_v1.yaml similarity index 99% rename from spec/yaml/twilio_fax.yaml rename to spec/yaml/twilio_fax_v1.yaml index 447e6fc6..561647bb 100644 --- a/spec/yaml/twilio_fax.yaml +++ b/spec/yaml/twilio_fax_v1.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Fax - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Faxes: diff --git a/spec/yaml/twilio_flex.yaml b/spec/yaml/twilio_flex_v1.yaml similarity index 99% rename from spec/yaml/twilio_flex.yaml rename to spec/yaml/twilio_flex_v1.yaml index 602e3a5e..530506e7 100644 --- a/spec/yaml/twilio_flex.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -256,7 +256,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Flex - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Channels: diff --git a/spec/yaml/twilio_insights.yaml b/spec/yaml/twilio_insights_v1.yaml similarity index 99% rename from spec/yaml/twilio_insights.yaml rename to spec/yaml/twilio_insights_v1.yaml index aec94222..889e8cf9 100644 --- a/spec/yaml/twilio_insights.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -390,7 +390,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Insights - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Video/Rooms: diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml new file mode 100644 index 00000000..045fe450 --- /dev/null +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -0,0 +1,2656 @@ +components: + schemas: + ip_messaging.v1.credential: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + sandbox: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + type: + enum: + - gcm + - apn + - fcm + type: string + url: + format: uri + type: string + type: object + ip_messaging.v1.service: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + consumption_report_interval: + type: integer + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + default_channel_creator_role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + default_channel_role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + default_service_role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + friendly_name: + type: string + limits: + type: object + links: + type: object + notifications: + type: object + post_webhook_url: + type: string + pre_webhook_url: + type: string + reachability_enabled: + type: boolean + read_status_enabled: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + typing_indicator_timeout: + type: integer + url: + format: uri + type: string + webhook_filters: + items: + type: string + type: array + webhook_method: + type: string + webhooks: + type: object + type: object + ip_messaging.v1.service.channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + members_count: + type: integer + messages_count: + type: integer + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + type: + enum: + - public + - private + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + ip_messaging.v1.service.channel.invite: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + identity: + type: string + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^IN[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + ip_messaging.v1.service.channel.member: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + identity: + type: string + last_consumed_message_index: + nullable: true + type: integer + last_consumption_timestamp: + format: date-time + type: string + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + ip_messaging.v1.service.channel.message: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + body: + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + from: + type: string + index: + type: integer + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + to: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + was_edited: + type: boolean + type: object + ip_messaging.v1.service.role: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + permissions: + items: + type: string + type: array + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: + enum: + - channel + - deployment + type: string + url: + format: uri + type: string + type: object + ip_messaging.v1.service.user: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + identity: + type: string + is_notifiable: + type: boolean + is_online: + type: boolean + joined_channels_count: + type: integer + links: + type: object + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + ip_messaging.v1.service.user.user_channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + last_consumed_message_index: + nullable: true + type: integer + links: + type: object + member_sid: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + status: + enum: + - joined + - invited + - not_participating + type: string + unread_messages_count: + nullable: true + type: integer + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Ip_messaging + version: 5.12.0 +openapi: 3.0.1 +paths: + /v1/Credentials: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + credentials: + items: + $ref: '#/components/schemas/ip_messaging.v1.credential' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ApiKey: + description: '' + type: string + Certificate: + description: '' + type: string + FriendlyName: + description: '' + type: string + PrivateKey: + description: '' + type: string + Sandbox: + description: '' + type: boolean + Secret: + description: '' + type: string + Type: + description: '' + enum: + - gcm + - apn + - fcm + type: string + required: + - Type + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.credential' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id001 + - sid + - friendly_name + - type + x-path-type: list + /v1/Credentials/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.credential' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ApiKey: + description: '' + type: string + Certificate: + description: '' + type: string + FriendlyName: + description: '' + type: string + PrivateKey: + description: '' + type: string + Sandbox: + description: '' + type: boolean + Secret: + description: '' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.credential' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /v1/Services: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + services: + items: + $ref: '#/components/schemas/ip_messaging.v1.service' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: '' + type: string + required: + - FriendlyName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id008 + - sid + - friendly_name + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: query + name: Type + schema: + items: + enum: + - public + - private + type: string + type: array + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + channels: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.channel' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: '' + type: string + FriendlyName: + description: '' + type: string + Type: + description: '' + enum: + - public + - private + type: string + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id005 + - sid + - unique_name + - friendly_name + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: query + name: Identity + schema: + items: + type: string + type: array + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + invites: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Identity: + description: '' + type: string + RoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + required: + - Identity + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id002 + - sid + - identity + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IN[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IN[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: query + name: Identity + schema: + items: + type: string + type: array + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + members: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Identity: + description: '' + type: string + RoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + required: + - Identity + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id003 + - sid + - identity + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + LastConsumedMessageIndex: + description: '' + nullable: true + type: integer + RoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: '' + in: query + name: Order + schema: + enum: + - asc + - desc + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + messages: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: '' + type: string + Body: + description: '' + type: string + From: + description: '' + type: string + required: + - Body + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id004 + - sid + - from + - to + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: '' + type: string + Body: + description: '' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /v1/Services/{ServiceSid}/Channels/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: '' + type: string + FriendlyName: + description: '' + type: string + UniqueName: + description: '' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.channel' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id005 + x-path-type: instance + /v1/Services/{ServiceSid}/Roles: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + roles: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.role' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: '' + type: string + Permission: + description: '' + items: + type: string + type: array + Type: + description: '' + enum: + - channel + - deployment + type: string + required: + - FriendlyName + - Type + - Permission + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.role' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id006 + - sid + - friendly_name + - type + x-path-type: list + /v1/Services/{ServiceSid}/Roles/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.role' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Permission: + description: '' + items: + type: string + type: array + required: + - Permission + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.role' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id006 + x-path-type: instance + /v1/Services/{ServiceSid}/Users: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.user' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: '' + type: string + FriendlyName: + description: '' + type: string + Identity: + description: '' + type: string + RoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + required: + - Identity + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.user' + description: Created + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: &id007 + - sid + - friendly_name + - date_created + x-path-type: list + /v1/Services/{ServiceSid}/Users/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.user' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Attributes: + description: '' + type: string + FriendlyName: + description: '' + type: string + RoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service.user' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id007 + x-path-type: instance + /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: UserSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + channels: + items: + $ref: '#/components/schemas/ip_messaging.v1.service.user.user_channel' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: + - channel_sid + - status + x-path-type: list + /v1/Services/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - GA + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ConsumptionReportInterval: + description: '' + type: integer + DefaultChannelCreatorRoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + DefaultChannelRoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + DefaultServiceRoleSid: + description: '' + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: '' + type: string + Limits.ChannelMembers: + description: '' + type: integer + Limits.UserChannels: + description: '' + type: integer + Notifications.AddedToChannel.Enabled: + description: '' + type: boolean + Notifications.AddedToChannel.Template: + description: '' + type: string + Notifications.InvitedToChannel.Enabled: + description: '' + type: boolean + Notifications.InvitedToChannel.Template: + description: '' + type: string + Notifications.NewMessage.Enabled: + description: '' + type: boolean + Notifications.NewMessage.Template: + description: '' + type: string + Notifications.RemovedFromChannel.Enabled: + description: '' + type: boolean + Notifications.RemovedFromChannel.Template: + description: '' + type: string + PostWebhookUrl: + description: '' + format: uri + type: string + PreWebhookUrl: + description: '' + format: uri + type: string + ReachabilityEnabled: + description: '' + type: boolean + ReadStatusEnabled: + description: '' + type: boolean + TypingIndicatorTimeout: + description: '' + type: integer + WebhookFilters: + description: '' + items: + type: string + type: array + WebhookMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelAdd.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelAdd.Url: + description: '' + format: uri + type: string + Webhooks.OnChannelAdded.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelAdded.Url: + description: '' + format: uri + type: string + Webhooks.OnChannelDestroy.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelDestroy.Url: + description: '' + format: uri + type: string + Webhooks.OnChannelDestroyed.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelDestroyed.Url: + description: '' + format: uri + type: string + Webhooks.OnChannelUpdate.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelUpdate.Url: + description: '' + format: uri + type: string + Webhooks.OnChannelUpdated.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnChannelUpdated.Url: + description: '' + format: uri + type: string + Webhooks.OnMemberAdd.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberAdd.Url: + description: '' + format: uri + type: string + Webhooks.OnMemberAdded.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberAdded.Url: + description: '' + format: uri + type: string + Webhooks.OnMemberRemove.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberRemove.Url: + description: '' + format: uri + type: string + Webhooks.OnMemberRemoved.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMemberRemoved.Url: + description: '' + format: uri + type: string + Webhooks.OnMessageRemove.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageRemove.Url: + description: '' + format: uri + type: string + Webhooks.OnMessageRemoved.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageRemoved.Url: + description: '' + format: uri + type: string + Webhooks.OnMessageSend.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageSend.Url: + description: '' + format: uri + type: string + Webhooks.OnMessageSent.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageSent.Url: + description: '' + format: uri + type: string + Webhooks.OnMessageUpdate.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageUpdate.Url: + description: '' + format: uri + type: string + Webhooks.OnMessageUpdated.Method: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Webhooks.OnMessageUpdated.Url: + description: '' + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/ip_messaging.v1.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://ip-messaging.twilio.com + x-default-output-properties: *id008 + x-path-type: instance +tags: +- description: This product is Generally Available. + name: GA diff --git a/spec/yaml/twilio_ip_messaging.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml similarity index 56% rename from spec/yaml/twilio_ip_messaging.yaml rename to spec/yaml/twilio_ip_messaging_v2.yaml index c8a95c57..9e4cda1f 100644 --- a/spec/yaml/twilio_ip_messaging.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -1,6 +1,6 @@ components: schemas: - ip_messaging.v1.credential: + ip_messaging.v2.credential: properties: account_sid: maxLength: 34 @@ -32,7 +32,7 @@ components: format: uri type: string type: object - ip_messaging.v1.service: + ip_messaging.v2.service: properties: account_sid: maxLength: 34 @@ -68,10 +68,16 @@ components: type: object links: type: object + media: + type: object notifications: type: object + post_webhook_retry_count: + type: integer post_webhook_url: type: string + pre_webhook_retry_count: + type: integer pre_webhook_url: type: string reachability_enabled: @@ -94,19 +100,24 @@ components: type: array webhook_method: type: string - webhooks: - type: object type: object - ip_messaging.v1.service.channel: + ip_messaging.v2.service.binding: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - attributes: + binding_type: + enum: + - gcm + - apn + - fcm type: string - created_by: + credential_sid: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ type: string date_created: format: date-time @@ -114,14 +125,16 @@ components: date_updated: format: date-time type: string - friendly_name: + endpoint: + type: string + identity: type: string links: type: object - members_count: - type: integer - messages_count: - type: integer + message_types: + items: + type: string + type: array service_sid: maxLength: 34 minLength: 34 @@ -130,30 +143,20 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - type: - enum: - - public - - private - type: string - unique_name: + pattern: ^BS[0-9a-fA-F]{32}$ type: string url: format: uri type: string type: object - ip_messaging.v1.service.channel.invite: + ip_messaging.v2.service.channel: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ + attributes: type: string created_by: type: string @@ -163,13 +166,14 @@ components: date_updated: format: date-time type: string - identity: - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ + friendly_name: type: string + links: + type: object + members_count: + type: integer + messages_count: + type: integer service_sid: maxLength: 34 minLength: 34 @@ -178,13 +182,20 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + type: + enum: + - public + - private + type: string + unique_name: type: string url: format: uri type: string type: object - ip_messaging.v1.service.channel.member: + ip_messaging.v2.service.channel.channel_webhook: properties: account_sid: maxLength: 34 @@ -196,25 +207,14 @@ components: minLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ type: string + configuration: + type: object date_created: format: date-time type: string date_updated: format: date-time type: string - identity: - type: string - last_consumed_message_index: - nullable: true - type: integer - last_consumption_timestamp: - format: date-time - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string service_sid: maxLength: 34 minLength: 34 @@ -223,78 +223,41 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ + pattern: ^WH[0-9a-fA-F]{32}$ + type: string + type: type: string url: format: uri type: string type: object - ip_messaging.v1.service.channel.message: + ip_messaging.v2.service.channel.invite: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - attributes: - type: string - body: - type: string channel_sid: maxLength: 34 minLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ type: string + created_by: + type: string date_created: format: date-time type: string date_updated: format: date-time type: string - from: - type: string - index: - type: integer - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - to: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - url: - format: uri + identity: type: string - was_edited: - type: boolean - type: object - ip_messaging.v1.service.role: - properties: - account_sid: + role_sid: maxLength: 34 minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: + pattern: ^RL[0-9a-fA-F]{32}$ type: string - permissions: - items: - type: string - type: array service_sid: maxLength: 34 minLength: 34 @@ -303,18 +266,13 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: - enum: - - channel - - deployment + pattern: ^IN[0-9a-fA-F]{32}$ type: string url: format: uri type: string type: object - ip_messaging.v1.service.user: + ip_messaging.v2.service.channel.member: properties: account_sid: maxLength: 34 @@ -323,24 +281,25 @@ components: type: string attributes: type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string date_created: format: date-time type: string date_updated: format: date-time type: string - friendly_name: - type: string identity: type: string - is_notifiable: - type: boolean - is_online: - type: boolean - joined_channels_count: + last_consumed_message_index: + nullable: true type: integer - links: - type: object + last_consumption_timestamp: + format: date-time + type: string role_sid: maxLength: 34 minLength: 34 @@ -354,55 +313,27 @@ components: sid: maxLength: 34 minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ + pattern: ^MB[0-9a-fA-F]{32}$ type: string url: format: uri type: string type: object - ip_messaging.v1.service.user.user_channel: + ip_messaging.v2.service.channel.message: properties: account_sid: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - last_consumed_message_index: - nullable: true - type: integer - links: - type: object - member_sid: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + attributes: type: string - status: - enum: - - joined - - invited - - not_participating + body: type: string - unread_messages_count: - nullable: true - type: integer - type: object - ip_messaging.v2.credential: - properties: - account_sid: + channel_sid: maxLength: 34 minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^CH[0-9a-fA-F]{32}$ type: string date_created: format: date-time @@ -410,2804 +341,240 @@ components: date_updated: format: date-time type: string - friendly_name: - type: string - sandbox: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - type: - enum: - - gcm - - apn - - fcm - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + from: type: string - consumption_report_interval: + index: type: integer - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - default_channel_creator_role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - default_channel_role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - default_service_role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - friendly_name: + last_updated_by: type: string - limits: - type: object - links: - type: object media: type: object - notifications: - type: object - post_webhook_retry_count: - type: integer - post_webhook_url: - type: string - pre_webhook_retry_count: - type: integer - pre_webhook_url: - type: string - reachability_enabled: - type: boolean - read_status_enabled: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - typing_indicator_timeout: - type: integer - url: - format: uri - type: string - webhook_filters: - items: - type: string - type: array - webhook_method: - type: string - type: object - ip_messaging.v2.service.binding: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - binding_type: - enum: - - gcm - - apn - - fcm - type: string - credential_sid: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - endpoint: - type: string - identity: - type: string - links: - type: object - message_types: - items: - type: string - type: array - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^BS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - members_count: - type: integer - messages_count: - type: integer - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - type: - enum: - - public - - private - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.channel.channel_webhook: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - configuration: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^WH[0-9a-fA-F]{32}$ - type: string - type: - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.channel.invite: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - identity: - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.channel.member: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - identity: - type: string - last_consumed_message_index: - nullable: true - type: integer - last_consumption_timestamp: - format: date-time - type: string - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.channel.message: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - body: - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - from: - type: string - index: - type: integer - last_updated_by: - type: string - media: - type: object - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - to: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - type: - type: string - url: - format: uri - type: string - was_edited: - type: boolean - type: object - ip_messaging.v2.service.role: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - permissions: - items: - type: string - type: array - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: - enum: - - channel - - deployment - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.user: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - attributes: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - identity: - type: string - is_notifiable: - type: boolean - is_online: - type: boolean - joined_channels_count: - type: integer - links: - type: object - role_sid: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - ip_messaging.v2.service.user.user_binding: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - binding_type: - enum: - - gcm - - apn - - fcm - type: string - credential_sid: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - endpoint: - type: string - identity: - type: string - message_types: - items: - type: string - type: array - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^BS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - user_sid: - maxLength: 34 - minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - type: string - type: object - ip_messaging.v2.service.user.user_channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - last_consumed_message_index: - nullable: true - type: integer - links: - type: object - member_sid: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - notification_level: - enum: - - default - - muted - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - status: - enum: - - joined - - invited - - not_participating - type: string - unread_messages_count: - nullable: true - type: integer - url: - format: uri - type: string - user_sid: - maxLength: 34 - minLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Ip_messaging - version: 1.3.0 -openapi: 3.0.1 -paths: - /v1/Credentials: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - credentials: - items: - $ref: '#/components/schemas/ip_messaging.v1.credential' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ApiKey: - description: '' - type: string - Certificate: - description: '' - type: string - FriendlyName: - description: '' - type: string - PrivateKey: - description: '' - type: string - Sandbox: - description: '' - type: boolean - Secret: - description: '' - type: string - Type: - description: '' - enum: - - gcm - - apn - - fcm - type: string - required: - - Type - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.credential' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id001 - - sid - - friendly_name - - type - x-path-type: list - /v1/Credentials/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.credential' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CR[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ApiKey: - description: '' - type: string - Certificate: - description: '' - type: string - FriendlyName: - description: '' - type: string - PrivateKey: - description: '' - type: string - Sandbox: - description: '' - type: boolean - Secret: - description: '' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.credential' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /v1/Services: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - services: - items: - $ref: '#/components/schemas/ip_messaging.v1.service' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: '' - type: string - required: - - FriendlyName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id008 - - sid - - friendly_name - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: query - name: Type - schema: - items: - enum: - - public - - private - type: string - type: array - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - channels: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.channel' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: '' - type: string - FriendlyName: - description: '' - type: string - Type: - description: '' - enum: - - public - - private - type: string - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id005 - - sid - - unique_name - - friendly_name - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: query - name: Identity - schema: - items: - type: string - type: array - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - invites: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Identity: - description: '' - type: string - RoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - required: - - Identity - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id002 - - sid - - identity - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IN[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: query - name: Identity - schema: - items: - type: string - type: array - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - members: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Identity: - description: '' - type: string - RoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - required: - - Identity - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id003 - - sid - - identity - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^MB[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - LastConsumedMessageIndex: - description: '' - nullable: true - type: integer - RoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: '' - in: query - name: Order - schema: - enum: - - asc - - desc - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - messages: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: '' - type: string - Body: - description: '' - type: string - From: - description: '' - type: string - required: - - Body - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id004 - - sid - - from - - to - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IM[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: '' - type: string - Body: - description: '' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /v1/Services/{ServiceSid}/Channels/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: '' - type: string - FriendlyName: - description: '' - type: string - UniqueName: - description: '' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.channel' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id005 - x-path-type: instance - /v1/Services/{ServiceSid}/Roles: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - roles: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.role' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: '' - type: string - Permission: - description: '' - items: - type: string - type: array - Type: - description: '' - enum: - - channel - - deployment - type: string - required: - - FriendlyName - - Type - - Permission - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.role' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id006 - - sid - - friendly_name - - type - x-path-type: list - /v1/Services/{ServiceSid}/Roles/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.role' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Permission: - description: '' - items: - type: string - type: array - required: - - Permission - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.role' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id006 - x-path-type: instance - /v1/Services/{ServiceSid}/Users: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.user' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: '' - type: string - FriendlyName: - description: '' - type: string - Identity: - description: '' - type: string - RoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - required: - - Identity - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.user' - description: Created - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: &id007 - - sid - - friendly_name - - date_created - x-path-type: list - /v1/Services/{ServiceSid}/Users/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.user' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Attributes: - description: '' - type: string - FriendlyName: - description: '' - type: string - RoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service.user' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id007 - x-path-type: instance - /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: UserSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - channels: - items: - $ref: '#/components/schemas/ip_messaging.v1.service.user.user_channel' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: - - channel_sid - - status - x-path-type: list - /v1/Services/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - GA - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ConsumptionReportInterval: - description: '' - type: integer - DefaultChannelCreatorRoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - DefaultChannelRoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - DefaultServiceRoleSid: - description: '' - maxLength: 34 - minLength: 34 - pattern: ^RL[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: '' - type: string - Limits.ChannelMembers: - description: '' - type: integer - Limits.UserChannels: - description: '' - type: integer - Notifications.AddedToChannel.Enabled: - description: '' - type: boolean - Notifications.AddedToChannel.Template: - description: '' - type: string - Notifications.InvitedToChannel.Enabled: - description: '' - type: boolean - Notifications.InvitedToChannel.Template: - description: '' - type: string - Notifications.NewMessage.Enabled: - description: '' - type: boolean - Notifications.NewMessage.Template: - description: '' - type: string - Notifications.RemovedFromChannel.Enabled: - description: '' - type: boolean - Notifications.RemovedFromChannel.Template: - description: '' - type: string - PostWebhookUrl: - description: '' - format: uri - type: string - PreWebhookUrl: - description: '' - format: uri - type: string - ReachabilityEnabled: - description: '' - type: boolean - ReadStatusEnabled: - description: '' - type: boolean - TypingIndicatorTimeout: - description: '' - type: integer - WebhookFilters: - description: '' - items: - type: string - type: array - WebhookMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelAdd.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelAdd.Url: - description: '' - format: uri - type: string - Webhooks.OnChannelAdded.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelAdded.Url: - description: '' - format: uri - type: string - Webhooks.OnChannelDestroy.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelDestroy.Url: - description: '' - format: uri - type: string - Webhooks.OnChannelDestroyed.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelDestroyed.Url: - description: '' - format: uri - type: string - Webhooks.OnChannelUpdate.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelUpdate.Url: - description: '' - format: uri - type: string - Webhooks.OnChannelUpdated.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnChannelUpdated.Url: - description: '' - format: uri - type: string - Webhooks.OnMemberAdd.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberAdd.Url: - description: '' - format: uri - type: string - Webhooks.OnMemberAdded.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberAdded.Url: - description: '' - format: uri - type: string - Webhooks.OnMemberRemove.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberRemove.Url: - description: '' - format: uri - type: string - Webhooks.OnMemberRemoved.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMemberRemoved.Url: - description: '' - format: uri - type: string - Webhooks.OnMessageRemove.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageRemove.Url: - description: '' - format: uri - type: string - Webhooks.OnMessageRemoved.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageRemoved.Url: - description: '' - format: uri - type: string - Webhooks.OnMessageSend.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageSend.Url: - description: '' - format: uri - type: string - Webhooks.OnMessageSent.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageSent.Url: - description: '' - format: uri - type: string - Webhooks.OnMessageUpdate.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageUpdate.Url: - description: '' - format: uri - type: string - Webhooks.OnMessageUpdated.Method: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Webhooks.OnMessageUpdated.Url: - description: '' - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/ip_messaging.v1.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://ip-messaging.twilio.com - x-default-output-properties: *id008 - x-path-type: instance + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^IM[0-9a-fA-F]{32}$ + type: string + to: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + type: + type: string + url: + format: uri + type: string + was_edited: + type: boolean + type: object + ip_messaging.v2.service.role: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + permissions: + items: + type: string + type: array + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + type: + enum: + - channel + - deployment + type: string + url: + format: uri + type: string + type: object + ip_messaging.v2.service.user: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + attributes: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + identity: + type: string + is_notifiable: + type: boolean + is_online: + type: boolean + joined_channels_count: + type: integer + links: + type: object + role_sid: + maxLength: 34 + minLength: 34 + pattern: ^RL[0-9a-fA-F]{32}$ + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + ip_messaging.v2.service.user.user_binding: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + binding_type: + enum: + - gcm + - apn + - fcm + type: string + credential_sid: + maxLength: 34 + minLength: 34 + pattern: ^CR[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + endpoint: + type: string + identity: + type: string + message_types: + items: + type: string + type: array + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^BS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + user_sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + type: object + ip_messaging.v2.service.user.user_channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + type: string + last_consumed_message_index: + nullable: true + type: integer + links: + type: object + member_sid: + maxLength: 34 + minLength: 34 + pattern: ^MB[0-9a-fA-F]{32}$ + type: string + notification_level: + enum: + - default + - muted + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + status: + enum: + - joined + - invited + - not_participating + type: string + unread_messages_count: + nullable: true + type: integer + url: + format: uri + type: string + user_sid: + maxLength: 34 + minLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Ip_messaging + version: 5.12.0 +openapi: 3.0.1 +paths: /v2/Credentials: description: 'TODO: Resource-level docs' get: @@ -3306,7 +673,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id009 + x-default-output-properties: &id001 - sid - friendly_name - type @@ -3404,7 +771,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id009 + x-default-output-properties: *id001 x-path-type: instance /v2/Services: description: 'TODO: Resource-level docs' @@ -3482,7 +849,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id020 + x-default-output-properties: &id012 - sid - friendly_name - date_created @@ -3566,7 +933,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id010 + x-default-output-properties: &id002 - sid - endpoint - identity @@ -3635,7 +1002,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id010 + x-default-output-properties: *id002 x-path-type: instance /v2/Services/{ServiceSid}/Channels: description: 'TODO: Resource-level docs' @@ -3771,7 +1138,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id015 + x-default-output-properties: &id007 - sid - unique_name - friendly_name @@ -3896,7 +1263,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id011 + x-default-output-properties: &id003 - sid - identity - date_created @@ -3977,7 +1344,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id011 + x-default-output-properties: *id003 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: description: 'TODO: Resource-level docs' @@ -4126,7 +1493,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id012 + x-default-output-properties: &id004 - sid - identity - date_created @@ -4283,7 +1650,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id012 + x-default-output-properties: *id004 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: description: 'TODO: Resource-level docs' @@ -4429,7 +1796,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id013 + x-default-output-properties: &id005 - sid - from - to @@ -4591,7 +1958,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id013 + x-default-output-properties: *id005 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: description: 'TODO: Resource-level docs' @@ -4732,7 +2099,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id014 + x-default-output-properties: &id006 - sid - configuration x-path-type: list @@ -4884,7 +2251,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id014 + x-default-output-properties: *id006 x-path-type: instance /v2/Services/{ServiceSid}/Channels/{Sid}: delete: @@ -5015,7 +2382,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id015 + x-default-output-properties: *id007 x-path-type: instance /v2/Services/{ServiceSid}/Roles: description: 'TODO: Resource-level docs' @@ -5125,7 +2492,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id016 + x-default-output-properties: &id008 - sid - friendly_name - type @@ -5239,7 +2606,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id016 + x-default-output-properties: *id008 x-path-type: instance /v2/Services/{ServiceSid}/Users: description: 'TODO: Resource-level docs' @@ -5356,7 +2723,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id017 + x-default-output-properties: &id009 - sid - friendly_name - identity @@ -5475,7 +2842,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id017 + x-default-output-properties: *id009 x-path-type: instance /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: description: 'TODO: Resource-level docs' @@ -5555,7 +2922,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id018 + x-default-output-properties: &id010 - sid - endpoint - identity @@ -5637,7 +3004,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id018 + x-default-output-properties: *id010 x-path-type: instance /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: description: 'TODO: Resource-level docs' @@ -5706,7 +3073,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: &id019 + x-default-output-properties: &id011 - channel_sid - status x-path-type: list @@ -5835,7 +3202,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id019 + x-default-output-properties: *id011 x-path-type: instance /v2/Services/{Sid}: delete: @@ -6031,7 +3398,7 @@ paths: - GA servers: - url: https://ip-messaging.twilio.com - x-default-output-properties: *id020 + x-default-output-properties: *id012 x-path-type: instance tags: - description: This product is Generally Available. diff --git a/spec/yaml/twilio_lookups.yaml b/spec/yaml/twilio_lookups_v1.yaml similarity index 99% rename from spec/yaml/twilio_lookups.yaml rename to spec/yaml/twilio_lookups_v1.yaml index 268f7759..0817ede5 100644 --- a/spec/yaml/twilio_lookups.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -33,7 +33,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Lookups - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_messaging.yaml b/spec/yaml/twilio_messaging_v1.yaml similarity index 99% rename from spec/yaml/twilio_messaging.yaml rename to spec/yaml/twilio_messaging_v1.yaml index 8582f85d..f42cbc31 100644 --- a/spec/yaml/twilio_messaging.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -209,7 +209,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Messaging - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Deactivations: diff --git a/spec/yaml/twilio_monitor.yaml b/spec/yaml/twilio_monitor_v1.yaml similarity index 99% rename from spec/yaml/twilio_monitor.yaml rename to spec/yaml/twilio_monitor_v1.yaml index c1f10d2b..3184ace7 100644 --- a/spec/yaml/twilio_monitor.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -194,7 +194,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Monitor - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Alerts: diff --git a/spec/yaml/twilio_notify.yaml b/spec/yaml/twilio_notify_v1.yaml similarity index 99% rename from spec/yaml/twilio_notify.yaml rename to spec/yaml/twilio_notify_v1.yaml index 8307ed43..29d4d99b 100644 --- a/spec/yaml/twilio_notify.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -221,7 +221,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Notify - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_numbers.yaml b/spec/yaml/twilio_numbers_v2.yaml similarity index 99% rename from spec/yaml/twilio_numbers.yaml rename to spec/yaml/twilio_numbers_v2.yaml index 49e79265..be40fc51 100644 --- a/spec/yaml/twilio_numbers.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -265,7 +265,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Numbers - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/RegulatoryCompliance/Bundles: diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml deleted file mode 100644 index 28e752f8..00000000 --- a/spec/yaml/twilio_preview.yaml +++ /dev/null @@ -1,9460 +0,0 @@ -components: - schemas: - preview.bulk_exports.export: - properties: - links: - type: object - resource_type: - type: string - url: - format: uri - type: string - type: object - preview.bulk_exports.export.day: - properties: - create_date: - type: string - day: - type: string - friendly_name: - type: string - resource_type: - type: string - size: - type: integer - type: object - preview.bulk_exports.export.day|instance: - properties: - redirect_to: - format: uri - type: string - type: object - preview.bulk_exports.export.export_custom_job: - properties: - details: - type: object - email: - type: string - end_day: - type: string - friendly_name: - type: string - job_sid: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - resource_type: - type: string - start_day: - type: string - webhook_method: - type: string - webhook_url: - type: string - type: object - preview.bulk_exports.export.job: - properties: - details: - type: object - email: - type: string - end_day: - type: string - friendly_name: - type: string - job_sid: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - resource_type: - type: string - start_day: - type: string - url: - format: uri - type: string - webhook_method: - type: string - webhook_url: - type: string - type: object - preview.bulk_exports.export_configuration: - properties: - enabled: - type: boolean - resource_type: - type: string - url: - format: uri - type: string - webhook_method: - type: string - webhook_url: - format: uri - type: string - type: object - preview.deployed_devices.fleet: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - default_deployment_sid: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.certificate: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - device_sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - fleet_sid: - type: string - friendly_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - thumbprint: - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.deployment: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - fleet_sid: - type: string - friendly_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - sync_service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.device: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_authenticated: - format: date-time - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - deployment_sid: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - enabled: - type: boolean - fleet_sid: - type: string - friendly_name: - type: string - identity: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.key: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - device_sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - fleet_sid: - type: string - friendly_name: - type: string - secret: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.hosted_numbers.authorization_document: - properties: - address_sid: - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - cc_emails: - items: - type: string - type: array - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - email: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - status: - enum: - - opened - - signing - - signed - - canceled - - failed - type: string - url: - format: uri - type: string - type: object - preview.hosted_numbers.authorization_document.dependent_hosted_number_order: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - address_sid: - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - call_delay: - type: integer - capabilities: - type: object - cc_emails: - items: - type: string - type: array - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - email: - type: string - extension: - type: string - failure_reason: - type: string - friendly_name: - type: string - incoming_phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - phone_number: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - signing_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - status: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - unique_name: - type: string - verification_attempts: - type: integer - verification_call_sids: - items: - type: string - type: array - verification_code: - type: string - verification_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - verification_type: - enum: - - phone-call - - phone-bill - type: string - type: object - preview.hosted_numbers.hosted_number_order: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - address_sid: - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - call_delay: - type: integer - capabilities: - type: object - cc_emails: - items: - type: string - type: array - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - email: - type: string - extension: - type: string - failure_reason: - type: string - friendly_name: - type: string - incoming_phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - phone_number: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - signing_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - status: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - unique_name: - type: string - url: - format: uri - type: string - verification_attempts: - type: integer - verification_call_sids: - items: - type: string - type: array - verification_code: - type: string - verification_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - verification_type: - enum: - - phone-call - - phone-bill - type: string - type: object - preview.marketplace.available_add_on: - properties: - configuration_schema: - type: object - description: - type: string - friendly_name: - type: string - links: - type: object - pricing_type: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.marketplace.available_add_on.available_add_on_extension: - properties: - available_add_on_sid: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - friendly_name: - type: string - product_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.marketplace.installed_add_on: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - configuration: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - description: - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.marketplace.installed_add_on.installed_add_on_extension: - properties: - enabled: - type: boolean - friendly_name: - type: string - installed_add_on_sid: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - product_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - acl_enabled: - type: boolean - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - reachability_webhooks_enabled: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - webhook_url: - format: uri - type: string - type: object - preview.sync.service.document: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - data: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - links: - type: object - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service.document.document_permission: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - document_sid: - maxLength: 34 - minLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - type: string - identity: - type: string - manage: - type: boolean - read: - type: boolean - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - write: - type: boolean - type: object - preview.sync.service.sync_list: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - links: - type: object - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_list.sync_list_item: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - data: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - index: - type: integer - list_sid: - maxLength: 34 - minLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - type: string - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_list.sync_list_permission: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - identity: - type: string - list_sid: - maxLength: 34 - minLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - type: string - manage: - type: boolean - read: - type: boolean - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - write: - type: boolean - type: object - preview.sync.service.sync_map: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - links: - type: object - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_map.sync_map_item: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - data: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - key: - type: string - map_sid: - maxLength: 34 - minLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - type: string - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_map.sync_map_permission: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - identity: - type: string - manage: - type: boolean - map_sid: - maxLength: 34 - minLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - type: string - read: - type: boolean - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - write: - type: boolean - type: object - preview.trusted_comms.branded_call: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - bg_color: - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - branded_channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - call_sid: - maxLength: 34 - minLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - caller: - type: string - created_at: - format: date-time - type: string - font_color: - type: string - from: - type: string - logo: - type: string - phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - reason: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CQ[0-9a-fA-F]{32}$ - type: string - status: - type: string - to: - type: string - url: - format: uri - type: string - use_case: - type: string - type: object - preview.trusted_comms.branded_channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.branded_channel.channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - branded_channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - phone_number: - type: string - phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.brands_information: - properties: - file_link: - format: uri - type: string - file_link_ttl_in_seconds: - type: string - update_time: - format: date-time - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.business: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.business.insights: - properties: {} - type: object - preview.trusted_comms.business.insights.insights_impressions_rate: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - end: - format: date-time - type: string - interval: - enum: - - minute - - hour - - day - - week - - month - type: string - reports: - type: object - start: - format: date-time - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.cps: - properties: - cps_url: - format: uri - type: string - phone_number: - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.current_call: - properties: - bg_color: - type: string - caller: - type: string - created_at: - format: date-time - type: string - font_color: - type: string - from: - type: string - logo: - type: string - manager: - type: string - reason: - type: string - shield_img: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CQ[0-9a-fA-F]{32}$ - type: string - status: - type: string - to: - type: string - url: - format: uri - type: string - use_case: - type: string - type: object - preview.trusted_comms.phone_call: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - bg_color: - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - branded_channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - call_sid: - maxLength: 34 - minLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - caller: - type: string - created_at: - format: date-time - type: string - font_color: - type: string - from: - type: string - logo: - type: string - phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - reason: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CQ[0-9a-fA-F]{32}$ - type: string - status: - type: string - to: - type: string - url: - format: uri - type: string - use_case: - type: string - type: object - preview.understand.assistant: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - callback_events: - type: string - callback_url: - format: uri - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - latest_model_build_sid: - maxLength: 34 - minLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - type: string - links: - type: object - log_queries: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.assistant_fallback_actions: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - url: - format: uri - type: string - type: object - preview.understand.assistant.assistant_initiation_actions: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - url: - format: uri - type: string - type: object - preview.understand.assistant.dialogue: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.field_type: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.field_type.field_value: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - field_type_sid: - maxLength: 34 - minLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ - type: string - language: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ - type: string - synonym_of: - maxLength: 34 - minLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - value: - type: string - type: object - preview.understand.assistant.model_build: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - build_duration: - nullable: true - type: integer - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - error_code: - nullable: true - type: integer - sid: - maxLength: 34 - minLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - type: string - status: - enum: - - enqueued - - building - - completed - - failed - - canceled - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.query: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - language: - type: string - model_build_sid: - maxLength: 34 - minLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - type: string - query: - type: string - results: - type: object - sample_sid: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UH[0-9a-fA-F]{32}$ - type: string - source_channel: - type: string - status: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.style_sheet: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - url: - format: uri - type: string - type: object - preview.understand.assistant.task: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - actions_url: - format: uri - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.field: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - field_type: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UE[0-9a-fA-F]{32}$ - type: string - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.sample: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - language: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - source_channel: - type: string - tagged_text: - type: string - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.task_actions: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.task_statistics: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - fields_count: - type: integer - samples_count: - type: integer - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.wireless.command: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - command: - type: string - command_mode: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - device_sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - direction: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - type: string - sim_sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - status: - type: string - url: - format: uri - type: string - type: object - preview.wireless.rate_plan: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - data_enabled: - type: boolean - data_limit: - type: integer - data_metering: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - international_roaming: - items: - type: string - type: array - messaging_enabled: - type: boolean - national_roaming_enabled: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - voice_enabled: - type: boolean - type: object - preview.wireless.sim: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - commands_callback_method: - type: string - commands_callback_url: - format: uri - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - e_id: - type: string - friendly_name: - type: string - iccid: - type: string - links: - type: object - rate_plan_sid: - maxLength: 34 - minLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - sms_fallback_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - sms_fallback_url: - format: uri - type: string - sms_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - sms_url: - format: uri - type: string - status: - type: string - unique_name: - type: string - url: - format: uri - type: string - voice_fallback_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - voice_fallback_url: - format: uri - type: string - voice_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - voice_url: - format: uri - type: string - type: object - preview.wireless.sim.usage: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - commands_costs: - type: object - commands_usage: - type: object - data_costs: - type: object - data_usage: - type: object - period: - type: object - sim_sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - sim_unique_name: - type: string - url: - format: uri - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /BulkExports/Exports/Jobs/{JobSid}: - delete: - description: '' - parameters: - - description: The unique string that that we created to identify the Bulk Export - job - in: path - name: JobSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: JobSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export.job' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /BulkExports/Exports/{ResourceType}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Export. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /BulkExports/Exports/{ResourceType}/Configuration: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Export Configuration. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export_configuration' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update a specific Export Configuration. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Enabled: - description: If true, Twilio will automatically generate every day's - file when the day is over. - type: boolean - WebhookMethod: - description: Sets whether Twilio should call a webhook URL when - the automatic generation is complete, using GET or POST. The actual - destination is set in the webhook_url - type: string - WebhookUrl: - description: Stores the URL destination for the method specified - in webhook_method. - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export_configuration' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /BulkExports/Exports/{ResourceType}/Days: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Days for a resource. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - days: - items: - $ref: '#/components/schemas/preview.bulk_exports.export.day' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /BulkExports/Exports/{ResourceType}/Days/{Day}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Day. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - - description: The ISO 8601 format date of the resources in the file, for a - UTC day - in: path - name: Day - required: true - schema: - type: string - responses: - 307: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export.day|instance' - description: Temporary Redirect - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /BulkExports/Exports/{ResourceType}/Jobs: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - jobs: - items: - $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: "The type of communication \u2013 Messages or Calls" - in: path - name: ResourceType - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Email: - description: The optional email to send the completion notification - to - type: string - EndDay: - description: The end day for the custom export specified as a string - in the format of yyyy-mm-dd. End day is inclusive and must be - 2 days earlier than the current UTC day. - type: string - FriendlyName: - description: The friendly name specified when creating the job - type: string - StartDay: - description: The start day for the custom export specified as a - string in the format of yyyy-mm-dd - type: string - WebhookMethod: - description: This is the method used to call the webhook on completion - of the job. If this is supplied, `WebhookUrl` must also be supplied. - type: string - WebhookUrl: - description: The optional webhook url called on completion of the - job. If this is supplied, `WebhookMethod` must also be supplied. - type: string - required: - - StartDay - - EndDay - - FriendlyName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: list - /DeployedDevices/Fleets: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Fleets belonging to your account. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - fleets: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create a new Fleet for scoping of deployed devices within your - account. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id006 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Certificates: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Certificate credentials belonging to the - Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Filters the resulting list of Certificates by a unique string - identifier of an authenticated Device. - in: query - name: DeviceSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - certificates: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Enroll a new Certificate credential to the Fleet, optionally giving - it a friendly name and assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CertificateData: - description: Provides a URL encoded representation of the public - certificate in PEM format. - type: string - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - type: string - required: - - CertificateData - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: - delete: - description: Unregister a specific Certificate credential from the Fleet, effectively - disallowing any inbound client connections that are presenting it. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Certificate credential in the - Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Certificate credential - in the Fleet, giving it a friendly name or assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /DeployedDevices/Fleets/{FleetSid}/Deployments: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Deployments belonging to the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - deployments: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create a new Deployment in the Fleet, optionally giving it a friendly - name and linking to a specific Twilio Sync service instance. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: Provides a human readable descriptive text for this - Deployment, up to 256 characters long. - type: string - SyncServiceSid: - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id003 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: - delete: - description: Delete a specific Deployment from the Fleet, leaving associated - devices effectively undeployed. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Deployment in the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Deployment credential - in the Fleet, giving it a friendly name or linking to a specific Twilio Sync - service instance. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: Provides a human readable descriptive text for this - Deployment, up to 64 characters long - type: string - SyncServiceSid: - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /DeployedDevices/Fleets/{FleetSid}/Devices: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Devices belonging to the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Filters the resulting list of Devices by a unique string identifier - of the Deployment they are associated with. - in: query - name: DeploymentSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - devices: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - 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. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeploymentSid: - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - Enabled: - description: '' - type: boolean - FriendlyName: - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - type: string - Identity: - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - type: string - UniqueName: - 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. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id004 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: - delete: - description: Delete a specific Device from the Fleet, also removing it from - associated Deployments. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Device in the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Device in the Fleet, - giving it a friendly name, assigning to a Deployment, or a human identity. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeploymentSid: - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - Enabled: - description: '' - type: boolean - FriendlyName: - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - type: string - Identity: - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /DeployedDevices/Fleets/{FleetSid}/Keys: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Keys credentials belonging to the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Filters the resulting list of Keys by a unique string identifier - of an authenticated Device. - in: query - name: DeviceSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - keys: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create a new Key credential in the Fleet, optionally giving it - a friendly name and assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id005 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: - delete: - description: Delete a specific Key credential from the Fleet, effectively disallowing - any inbound client connections that are presenting it. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Key credential in the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Key credential in the - Fleet, giving it a friendly name or assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id005 - x-path-type: instance - /DeployedDevices/Fleets/{Sid}: - delete: - description: 'Delete a specific Fleet from your account, also destroys all nested - resources: Devices, Deployments, Certificates, Keys.' - parameters: - - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Fleet in your account. - parameters: - - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the friendly name property of a specific Fleet in your account. - parameters: - - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DefaultDeploymentSid: - description: Provides a string identifier of a Deployment that is - going to be used as a default one for this Fleet. - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id006 - x-path-type: instance - /HostedNumbers/AuthorizationDocuments: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of AuthorizationDocuments belonging to the account - initiating the request. - parameters: - - description: Email that this AuthorizationDocument will be sent to for signing. - in: query - name: Email - schema: - type: string - - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - in: query - name: Status - schema: - enum: - - opened - - signing - - signed - - canceled - - failed - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create an AuthorizationDocument for authorizing the hosting of - phone number capabilities on Twilio's platform. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AddressSid: - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - CcEmails: - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - items: - type: string - type: array - ContactPhoneNumber: - description: The contact phone number of the person authorized to - sign the Authorization Document. - type: string - ContactTitle: - description: The title of the person authorized to sign the Authorization - Document for this phone number. - type: string - Email: - description: Email that this AuthorizationDocument will be sent - to for signing. - type: string - HostedNumberOrderSids: - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - items: - type: string - type: array - required: - - HostedNumberOrderSids - - AddressSid - - Email - - ContactTitle - - ContactPhoneNumber - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id007 [] - x-path-type: list - /HostedNumbers/AuthorizationDocuments/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific AuthorizationDocument. - parameters: - - description: A 34 character string that uniquely identifies this AuthorizationDocument. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates a specific AuthorizationDocument. - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AddressSid: - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - CcEmails: - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - items: - type: string - type: array - ContactPhoneNumber: - description: The contact phone number of the person authorized to - sign the Authorization Document. - type: string - ContactTitle: - description: The title of the person authorized to sign the Authorization - Document for this phone number. - type: string - Email: - description: Email that this AuthorizationDocument will be sent - to for signing. - type: string - HostedNumberOrderSids: - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - items: - type: string - type: array - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - enum: - - opened - - signing - - signed - - canceled - - failed - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id007 - x-path-type: instance - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. - parameters: - - description: '' - in: path - name: SigningDocumentSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - in: query - name: Status - schema: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - - description: An E164 formatted phone number hosted by this HostedNumberOrder. - in: query - name: PhoneNumber - schema: - type: string - - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - in: query - name: IncomingPhoneNumberSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - - description: A human readable description of this resource, up to 64 characters. - in: query - name: FriendlyName - schema: - 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. - in: query - name: UniqueName - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: list - /HostedNumbers/HostedNumberOrders: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. - parameters: - - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. - in: query - name: Status - schema: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - - description: An E164 formatted phone number hosted by this HostedNumberOrder. - in: query - name: PhoneNumber - schema: - type: string - - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - in: query - name: IncomingPhoneNumberSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - - description: A human readable description of this resource, up to 64 characters. - in: query - name: FriendlyName - schema: - 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. - in: query - name: UniqueName - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Host a phone number's capability on Twilio's platform. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AccountSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - AddressSid: - description: Optional. A 34 character string that uniquely identifies - the Address resource that represents the address of the owner - of this phone number. - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - CcEmails: - description: Optional. A list of emails that the LOA document for - this HostedNumberOrder will be carbon copied to. - items: - type: string - type: array - Email: - description: Optional. Email of the owner of this phone number that - is being hosted. - type: string - FriendlyName: - description: A 64 character string that is a human readable text - that describes this resource. - type: string - PhoneNumber: - description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) - format - type: string - SmsApplicationSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - type: string - SmsCapability: - description: Used to specify that the SMS capability will be hosted - on Twilio's platform. - type: boolean - SmsFallbackMethod: - 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. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsFallbackUrl: - 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. - format: uri - type: string - SmsMethod: - 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. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsUrl: - description: The URL that Twilio should request when somebody sends - an SMS to the phone number. This will be copied onto the IncomingPhoneNumber - resource. - format: uri - type: string - StatusCallbackMethod: - description: Optional. The Status Callback Method attached to the - IncomingPhoneNumber resource. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - StatusCallbackUrl: - description: Optional. The Status Callback URL attached to the IncomingPhoneNumber - resource. - format: uri - type: string - UniqueName: - 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. - type: string - VerificationDocumentSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - VerificationType: - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - enum: - - phone-call - - phone-bill - type: string - required: - - PhoneNumber - - SmsCapability - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id008 [] - x-path-type: list - /HostedNumbers/HostedNumberOrders/{Sid}: - delete: - description: Cancel the HostedNumberOrder (only available when the status is - in `received`). - parameters: - - description: A 34 character string that uniquely identifies this HostedNumberOrder. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific HostedNumberOrder. - parameters: - - description: A 34 character string that uniquely identifies this HostedNumberOrder. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates a specific HostedNumberOrder. - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallDelay: - description: The number of seconds, between 0 and 60, to delay before - initiating the verification call. Defaults to 0. - type: integer - CcEmails: - description: Optional. A list of emails that LOA document for this - HostedNumberOrder will be carbon copied to. - items: - type: string - type: array - Email: - description: Email of the owner of this phone number that is being - hosted. - type: string - Extension: - description: Digits to dial after connecting the verification call. - type: string - FriendlyName: - description: A 64 character string that is a human readable text - that describes this resource. - type: string - 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. - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - UniqueName: - 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. - type: string - VerificationCode: - description: A verification code that is given to the user via a - phone call to the phone number that is being hosted. - type: string - VerificationDocumentSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - VerificationType: - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - enum: - - phone-call - - phone-bill - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id008 - x-path-type: instance - /Sync/Services: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - services: - items: - $ref: '#/components/schemas/preview.sync.service' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AclEnabled: - description: '' - type: boolean - FriendlyName: - description: '' - type: string - ReachabilityWebhooksEnabled: - description: '' - type: boolean - WebhookUrl: - description: '' - format: uri - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id017 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Documents: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - documents: - items: - $ref: '#/components/schemas/preview.sync.service.document' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id010 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Permissions applying to a Sync Document. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - permissions: - items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id009 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: - delete: - description: Delete a specific Sync Document Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Sync Document Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an identity's access to a specific Sync Document. - parameters: - - description: The unique SID identifier of the Sync Service Instance. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Manage: - description: Boolean flag specifying whether the identity can delete - the Sync Document. - type: boolean - Read: - description: Boolean flag specifying whether the identity can read - the Sync Document. - type: boolean - Write: - description: Boolean flag specifying whether the identity can update - the Sync Document. - type: boolean - required: - - Read - - Write - - Manage - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id009 - x-path-type: instance - /Sync/Services/{ServiceSid}/Documents/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id010 - x-path-type: instance - /Sync/Services/{ServiceSid}/Lists: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - lists: - items: - $ref: '#/components/schemas/preview.sync.service.sync_list' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id013 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: query - name: Order - schema: - enum: - - asc - - desc - type: string - - description: '' - in: query - name: From - schema: - type: string - - description: '' - in: query - name: Bounds - schema: - enum: - - inclusive - - exclusive - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id011 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: path - name: Index - required: true - schema: - type: integer - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: path - name: Index - required: true - schema: - type: integer - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: path - name: Index - required: true - schema: - type: integer - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id011 - x-path-type: instance - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Permissions applying to a Sync List. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - permissions: - items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id012 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: - delete: - description: Delete a specific Sync List Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Sync List Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an identity's access to a specific Sync List. - parameters: - - description: The unique SID identifier of the Sync Service Instance. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Manage: - description: Boolean flag specifying whether the identity can delete - the Sync List. - type: boolean - Read: - description: Boolean flag specifying whether the identity can read - the Sync List. - type: boolean - Write: - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync List. - type: boolean - required: - - Read - - Write - - Manage - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id012 - x-path-type: instance - /Sync/Services/{ServiceSid}/Lists/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id013 - x-path-type: instance - /Sync/Services/{ServiceSid}/Maps: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - maps: - items: - $ref: '#/components/schemas/preview.sync.service.sync_map' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id016 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: query - name: Order - schema: - enum: - - asc - - desc - type: string - - description: '' - in: query - name: From - schema: - type: string - - description: '' - in: query - name: Bounds - schema: - enum: - - inclusive - - exclusive - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - Key: - description: '' - type: string - required: - - Key - - Data - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id014 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: path - name: Key - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: path - name: Key - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: path - name: Key - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id014 - x-path-type: instance - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Permissions applying to a Sync Map. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - permissions: - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id015 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: - delete: - description: Delete a specific Sync Map Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Sync Map Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an identity's access to a specific Sync Map. - parameters: - - description: The unique SID identifier of the Sync Service Instance. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Manage: - description: Boolean flag specifying whether the identity can delete - the Sync Map. - type: boolean - Read: - description: Boolean flag specifying whether the identity can read - the Sync Map. - type: boolean - Write: - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync Map. - type: boolean - required: - - Read - - Write - - Manage - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id015 - x-path-type: instance - /Sync/Services/{ServiceSid}/Maps/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id016 - x-path-type: instance - /Sync/Services/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AclEnabled: - description: '' - type: boolean - FriendlyName: - description: '' - type: string - ReachabilityWebhooksEnabled: - description: '' - type: boolean - WebhookUrl: - description: '' - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id017 - x-path-type: instance - /TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels: - description: 'TODO: Resource-level docs' - post: - description: Associate a channel to a branded channel - parameters: - - description: The unique SID identifier of the Branded Channel. The given phone - number is going to be assigned to this Branded Channel - in: path - name: BrandedChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - PhoneNumberSid: - description: The unique SID identifier of the Phone Number of the - Phone number to be assigned to the Branded Channel. - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - required: - - PhoneNumberSid - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.branded_channel.channel' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - business_sid - - brand_sid - - branded_channel_sid - - phone_number_sid - - phone_number - - url - x-path-type: list - /TrustedComms/BrandedChannels/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Branded Channel. - parameters: - - description: The unique SID identifier of the Branded Channel. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.branded_channel' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - business_sid - - brand_sid - - sid - - links - - url - x-path-type: instance - /TrustedComms/BrandsInformation: - description: 'TODO: Resource-level docs' - get: - description: Retrieve the newest available BrandInformation - parameters: - - description: The If-None-Match HTTP request header - in: header - name: If-None-Match - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.brands_information' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - update_time - - file_link - - file_link_ttl_in_seconds - - url - x-path-type: instance - /TrustedComms/Business/BrandedCalls: - description: 'TODO: Resource-level docs' - post: - description: Brands a Call without actually placing it. Useful for cases when - the Customer wants to initiate the call themselves right after calling this - endpoint. This can be used also through a TwiML using `+1500456`, - and right after doing `+1500456` - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallSid: - description: The Call sid this Branded Call should link to. - maxLength: 34 - minLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - From: - description: The phone number to use as the caller id, given in - [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - It must be a Twilio number that has been set up as a Branded Number - in the Business Profile section for your account. - type: string - Reason: - description: The business reason for this phone call that will appear - in the terminating device's screen. Max 50 characters. - type: string - To: - description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - type: string - required: - - From - - To - - Reason - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.branded_call' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - bg_color - - brand_sid - - branded_channel_sid - - business_sid - - call_sid - - caller - - created_at - - font_color - - from - - logo - - phone_number_sid - - reason - - sid - - status - - to - - url - - use_case - x-path-type: list - /TrustedComms/Business/PhoneCalls: - description: 'TODO: Resource-level docs' - post: - description: Initiates a Branded Call. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ApplicationSid: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - maxLength: 34 - minLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - type: string - CallerId: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - FallbackMethod: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - FallbackUrl: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - format: uri - type: string - From: - description: The phone number to use as the caller id, given in - [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - It must be a Twilio number that has been set up as a Branded Number - in the Business Profile section for your account. - type: string - MachineDetection: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - MachineDetectionSilenceTimeout: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - MachineDetectionSpeechEndThreshold: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - MachineDetectionSpeechThreshold: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - MachineDetectionTimeout: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - Method: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Reason: - description: The business reason for this phone call that will appear - in the terminating device's screen. Max 50 characters. - type: string - Record: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: boolean - RecordingChannels: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - RecordingStatusCallback: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - RecordingStatusCallbackEvent: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - items: - type: string - type: array - RecordingStatusCallbackMethod: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SendDigits: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - SipAuthPassword: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - SipAuthUsername: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - StatusCallback: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - format: uri - type: string - StatusCallbackEvent: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - items: - type: string - type: array - StatusCallbackMethod: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Timeout: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - To: - description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - type: string - Trim: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - Url: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - format: uri - type: string - required: - - From - - To - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.phone_call' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - bg_color - - brand_sid - - branded_channel_sid - - business_sid - - call_sid - - caller - - created_at - - font_color - - from - - logo - - phone_number_sid - - reason - - sid - - status - - to - - url - - use_case - x-path-type: list - /TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Impressions Rate. - parameters: - - description: The unique SID identifier of the Business to filter by. - in: path - name: BusinessSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - - description: The unique SID identifier of the Brand to filter by. - in: query - name: BrandSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - - description: The unique SID identifier of the Branded Channel to filter by. - in: query - name: BrandedChannelSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - - description: The unique SID identifier of the Phone Number to filter by. - in: query - name: PhoneNumberSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - - description: The 2-letter ISO 3166 code of the Country to filter by. - in: query - name: Country - schema: - type: string - - description: The start date that for this Impressions Rate, given in ISO 8601 - format. Default value is 30 days ago. - in: query - name: Start - schema: - format: date-time - type: string - - description: The end date that for this Impressions Rate, given in ISO 8601 - format. Default value is current timestamp. - in: query - name: End - schema: - format: date-time - type: string - - description: The Interval of this Impressions Rate. One of `minute`, `hour`, - `day`, `week` or `month`. - in: query - name: Interval - schema: - enum: - - minute - - hour - - day - - week - - month - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - start - - end - - interval - - business_sid - - reports - - url - x-path-type: instance - /TrustedComms/Businesses/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Business. - parameters: - - description: A 34 character string that uniquely identifies this Business. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.business' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - sid - - url - - links - x-path-type: instance - /TrustedComms/CPS: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Call Placement Service (CPS) given a phone number - via `X-XCNAM-Sensitive-Phone-Number` header. - parameters: - - description: The X-Xcnam-Sensitive-Phone-Number HTTP request header - in: header - name: X-Xcnam-Sensitive-Phone-Number - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.cps' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - cps_url - - phone_number - - url - x-path-type: instance - /TrustedComms/CurrentCall: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a current call given the originating and terminating number - via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` - headers. - parameters: - - description: The X-Xcnam-Sensitive-Phone-Number-From HTTP request header - in: header - name: X-Xcnam-Sensitive-Phone-Number-From - schema: - type: string - - description: The X-Xcnam-Sensitive-Phone-Number-To HTTP request header - in: header - name: X-Xcnam-Sensitive-Phone-Number-To - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.current_call' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - bg_color - - caller - - created_at - - font_color - - from - - logo - - manager - - reason - - shield_img - - sid - - status - - to - - url - - use_case - x-path-type: instance - /marketplace/AvailableAddOns: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Add-ons currently available to be installed. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - available_add_ons: - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id019 [] - x-path-type: list - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Extensions for the Available Add-on. - parameters: - - description: The SID of the AvailableAddOn resource with the extensions to - read. - in: path - name: AvailableAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - extensions: - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id018 [] - x-path-type: list - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Extension for the Available Add-on. - parameters: - - description: The SID of the AvailableAddOn resource with the extension to - fetch. - in: path - name: AvailableAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - - description: The SID of the AvailableAddOn Extension resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id018 - x-path-type: instance - /marketplace/AvailableAddOns/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Add-on currently available to be installed. - parameters: - - description: The SID of the AvailableAddOn resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id019 - x-path-type: instance - /marketplace/InstalledAddOns: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Add-ons currently installed on this Account. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - installed_add_ons: - items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Install an Add-on for the Account specified. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AcceptTermsOfService: - description: Whether the Terms of Service were accepted. - type: boolean - AvailableAddOnSid: - description: The SID of the AvaliableAddOn to install. - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - Configuration: - description: The JSON object that represents the configuration of - the new Add-on being installed. - type: object - UniqueName: - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - type: string - required: - - AvailableAddOnSid - - AcceptTermsOfService - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id021 [] - x-path-type: list - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Extensions for the Installed Add-on. - parameters: - - description: The SID of the InstalledAddOn resource with the extensions to - read. - in: path - name: InstalledAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - extensions: - items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id020 [] - x-path-type: list - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Extension for the Installed Add-on. - parameters: - - description: The SID of the InstalledAddOn resource with the extension to - fetch. - in: path - name: InstalledAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - - description: The SID of the InstalledAddOn Extension resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an Extension for an Add-on installation. - parameters: - - description: The SID of the InstalledAddOn resource with the extension to - update. - in: path - name: InstalledAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - - description: The SID of the InstalledAddOn Extension resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Enabled: - description: Whether the Extension should be invoked. - type: boolean - required: - - Enabled - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id020 - x-path-type: instance - /marketplace/InstalledAddOns/{Sid}: - delete: - description: Remove an Add-on installation from your account - parameters: - - description: The SID of the InstalledAddOn resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Add-on currently installed on this Account. - parameters: - - description: The SID of the InstalledAddOn resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an Add-on installation for the Account specified. - parameters: - - description: The SID of the InstalledAddOn resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - 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 - type: object - UniqueName: - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id021 - x-path-type: instance - /understand/Assistants: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - assistants: - items: - $ref: '#/components/schemas/preview.understand.assistant' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackEvents: - description: Space-separated list of callback events that will trigger - callbacks. - type: string - CallbackUrl: - description: A user-provided URL to send event callbacks to. - format: uri - type: string - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - type: object - FriendlyName: - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - type: string - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - type: object - LogQueries: - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - type: boolean - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - type: object - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id029 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.dialogue' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/FallbackActions: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FallbackActions: - description: '' - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/FieldTypes: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - field_types: - items: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - UniqueName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id023 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - - description: 'An ISO language-country string of the value. For example: *en-US*' - in: query - name: Language - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - field_values: - items: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Language: - description: An ISO language-country string of the value. - type: string - SynonymOf: - description: A value that indicates this field value is a synonym - of. Empty if the value is not a synonym. - type: string - Value: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - Language - - Value - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id022 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id022 - x-path-type: instance - /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id023 - x-path-type: instance - /understand/Assistants/{AssistantSid}/InitiationActions: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - InitiationActions: - description: '' - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/ModelBuilds: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - model_builds: - items: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - StatusCallback: - description: '' - format: uri - type: string - UniqueName: - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id024 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - UniqueName: - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id024 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Queries: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: An ISO language-country string of the sample. - in: query - name: Language - schema: - type: string - - description: The Model Build Sid or unique name of the Model Build to be queried. - in: query - name: ModelBuild - schema: - type: string - - description: 'A string that described the query status. The values can be: - pending_review, reviewed, discarded' - in: query - name: Status - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - queries: - items: - $ref: '#/components/schemas/preview.understand.assistant.query' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Field: - description: Constraints the query to a given Field with an task. - Useful when you know the Field you are expecting. It accepts one - field in the format *task-unique-name-1*:*field-unique-name* - type: string - Language: - description: An ISO language-country string of the sample. - type: string - ModelBuild: - description: The Model Build Sid or unique name of the Model Build - to be queried. - type: string - Query: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. It can be up to 2048 characters - long. - type: string - Tasks: - description: Constraints the query to a set of tasks. Useful when - you need to constrain the paths the user can take. Tasks should - be comma separated *task-unique-name-1*, *task-unique-name-2* - type: string - required: - - Language - - Query - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id025 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Queries/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - SampleSid: - description: An optional reference to the Sample created from this - query. - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - Status: - description: 'A string that described the query status. The values - can be: pending_review, reviewed, discarded' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id025 - x-path-type: instance - /understand/Assistants/{AssistantSid}/StyleSheet: - description: 'TODO: Resource-level docs' - get: - description: Returns Style sheet JSON object for this Assistant - parameters: - - description: The unique ID of the Assistant - in: path - name: AssistantSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates the style sheet for an assistant identified by {AssistantSid} - or {AssistantUniqueName}. - parameters: - - description: The unique ID of the Assistant - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - StyleSheet: - description: The JSON Style sheet string - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - tasks: - items: - $ref: '#/components/schemas/preview.understand.assistant.task' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - type: object - ActionsUrl: - description: User-provided HTTP endpoint where from the assistant - fetches actions - format: uri - type: string - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - UniqueName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id026 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Tasks/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - type: object - ActionsUrl: - description: User-provided HTTP endpoint where from the assistant - fetches actions - format: uri - type: string - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id026 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: - description: 'TODO: Resource-level docs' - get: - description: Returns JSON actions for this Task. - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task. - in: path - name: TaskSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task. - in: path - name: TaskSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Actions: - description: The JSON actions that instruct the Assistant how to - perform this task. - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - fields: - items: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FieldType: - description: The unique name or sid of the FieldType. It can be - any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) - or the unique_name or the Field Type sid of a custom Field Type. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - FieldType - - UniqueName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id027 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id027 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: An ISO language-country string of the sample. - in: query - name: Language - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - samples: - items: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Language: - description: An ISO language-country string of the sample. - type: string - SourceChannel: - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - type: string - TaggedText: - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - type: string - required: - - Language - - TaggedText - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id028 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Language: - description: An ISO language-country string of the sample. - type: string - SourceChannel: - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - type: string - TaggedText: - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id028 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{Sid}: - delete: - description: '' - parameters: - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackEvents: - description: Space-separated list of callback events that will trigger - callbacks. - type: string - CallbackUrl: - description: A user-provided URL to send event callbacks to. - format: uri - type: string - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - type: object - FriendlyName: - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - type: string - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - type: object - LogQueries: - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - type: boolean - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - type: object - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id029 - x-path-type: instance - /wireless/Commands: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: query - name: Device - schema: - type: string - - description: '' - in: query - name: Sim - schema: - type: string - - description: '' - in: query - name: Status - schema: - type: string - - description: '' - in: query - name: Direction - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - commands: - items: - $ref: '#/components/schemas/preview.wireless.command' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackMethod: - description: '' - type: string - CallbackUrl: - description: '' - format: uri - type: string - Command: - description: '' - type: string - CommandMode: - description: '' - type: string - Device: - description: '' - type: string - IncludeSid: - description: '' - type: string - Sim: - description: '' - type: string - required: - - Command - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.command' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id030 [] - x-path-type: list - /wireless/Commands/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.command' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id030 - x-path-type: instance - /wireless/RatePlans: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - rate_plans: - items: - $ref: '#/components/schemas/preview.wireless.rate_plan' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CommandsEnabled: - description: '' - type: boolean - DataEnabled: - description: '' - type: boolean - DataLimit: - description: '' - type: integer - DataMetering: - description: '' - type: string - FriendlyName: - description: '' - type: string - InternationalRoaming: - description: '' - items: - type: string - type: array - MessagingEnabled: - description: '' - type: boolean - NationalRoamingEnabled: - description: '' - type: boolean - UniqueName: - description: '' - type: string - VoiceEnabled: - description: '' - type: boolean - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id031 [] - x-path-type: list - /wireless/RatePlans/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: '' - type: string - UniqueName: - description: '' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id031 - x-path-type: instance - /wireless/Sims: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: query - name: Status - schema: - type: string - - description: '' - in: query - name: Iccid - schema: - type: string - - description: '' - in: query - name: RatePlan - schema: - type: string - - description: '' - in: query - name: EId - schema: - type: string - - description: '' - in: query - name: SimRegistrationCode - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - sims: - items: - $ref: '#/components/schemas/preview.wireless.sim' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id032 [] - x-path-type: list - /wireless/Sims/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackMethod: - description: '' - type: string - CallbackUrl: - description: '' - format: uri - type: string - CommandsCallbackMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - CommandsCallbackUrl: - description: '' - format: uri - type: string - FriendlyName: - description: '' - type: string - RatePlan: - description: '' - type: string - SmsFallbackMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsFallbackUrl: - description: '' - format: uri - type: string - SmsMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsUrl: - description: '' - format: uri - type: string - Status: - description: '' - type: string - UniqueName: - description: '' - type: string - VoiceFallbackMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - VoiceFallbackUrl: - description: '' - format: uri - type: string - VoiceMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - VoiceUrl: - description: '' - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id032 - x-path-type: instance - /wireless/Sims/{SimSid}/Usage: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: SimSid - required: true - schema: - type: string - - description: '' - in: query - name: End - schema: - type: string - - description: '' - in: query - name: Start - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim.usage' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_bulk_exports.yaml b/spec/yaml/twilio_preview_bulk_exports.yaml new file mode 100644 index 00000000..095ec0d4 --- /dev/null +++ b/spec/yaml/twilio_preview_bulk_exports.yaml @@ -0,0 +1,468 @@ +components: + schemas: + preview.bulk_exports.export: + properties: + links: + type: object + resource_type: + type: string + url: + format: uri + type: string + type: object + preview.bulk_exports.export.day: + properties: + create_date: + type: string + day: + type: string + friendly_name: + type: string + resource_type: + type: string + size: + type: integer + type: object + preview.bulk_exports.export.day|instance: + properties: + redirect_to: + format: uri + type: string + type: object + preview.bulk_exports.export.export_custom_job: + properties: + details: + type: object + email: + type: string + end_day: + type: string + friendly_name: + type: string + job_sid: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + resource_type: + type: string + start_day: + type: string + webhook_method: + type: string + webhook_url: + type: string + type: object + preview.bulk_exports.export.job: + properties: + details: + type: object + email: + type: string + end_day: + type: string + friendly_name: + type: string + job_sid: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + resource_type: + type: string + start_day: + type: string + url: + format: uri + type: string + webhook_method: + type: string + webhook_url: + type: string + type: object + preview.bulk_exports.export_configuration: + properties: + enabled: + type: boolean + resource_type: + type: string + url: + format: uri + type: string + webhook_method: + type: string + webhook_url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /BulkExports/Exports/Jobs/{JobSid}: + delete: + description: '' + parameters: + - description: The unique string that that we created to identify the Bulk Export + job + in: path + name: JobSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: JobSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export.job' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /BulkExports/Exports/{ResourceType}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Export. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /BulkExports/Exports/{ResourceType}/Configuration: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Export Configuration. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export_configuration' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update a specific Export Configuration. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Enabled: + description: If true, Twilio will automatically generate every day's + file when the day is over. + type: boolean + WebhookMethod: + description: Sets whether Twilio should call a webhook URL when + the automatic generation is complete, using GET or POST. The actual + destination is set in the webhook_url + type: string + WebhookUrl: + description: Stores the URL destination for the method specified + in webhook_method. + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export_configuration' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /BulkExports/Exports/{ResourceType}/Days: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Days for a resource. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + days: + items: + $ref: '#/components/schemas/preview.bulk_exports.export.day' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /BulkExports/Exports/{ResourceType}/Days/{Day}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Day. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + - description: The ISO 8601 format date of the resources in the file, for a + UTC day + in: path + name: Day + required: true + schema: + type: string + responses: + 307: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export.day|instance' + description: Temporary Redirect + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /BulkExports/Exports/{ResourceType}/Jobs: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + jobs: + items: + $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: "The type of communication \u2013 Messages or Calls" + in: path + name: ResourceType + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Email: + description: The optional email to send the completion notification + to + type: string + EndDay: + description: The end day for the custom export specified as a string + in the format of yyyy-mm-dd. End day is inclusive and must be + 2 days earlier than the current UTC day. + type: string + FriendlyName: + description: The friendly name specified when creating the job + type: string + StartDay: + description: The start day for the custom export specified as a + string in the format of yyyy-mm-dd + type: string + WebhookMethod: + description: This is the method used to call the webhook on completion + of the job. If this is supplied, `WebhookUrl` must also be supplied. + type: string + WebhookUrl: + description: The optional webhook url called on completion of the + job. If this is supplied, `WebhookMethod` must also be supplied. + type: string + required: + - StartDay + - EndDay + - FriendlyName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: list +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_deployed_devices.yaml b/spec/yaml/twilio_preview_deployed_devices.yaml new file mode 100644 index 00000000..52346463 --- /dev/null +++ b/spec/yaml/twilio_preview_deployed_devices.yaml @@ -0,0 +1,1242 @@ +components: + schemas: + preview.deployed_devices.fleet: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + default_deployment_sid: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.certificate: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + device_sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + fleet_sid: + type: string + friendly_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + thumbprint: + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.deployment: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + fleet_sid: + type: string + friendly_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + sync_service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.device: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_authenticated: + format: date-time + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + deployment_sid: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + enabled: + type: boolean + fleet_sid: + type: string + friendly_name: + type: string + identity: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.key: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + device_sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + fleet_sid: + type: string + friendly_name: + type: string + secret: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /DeployedDevices/Fleets: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Fleets belonging to your account. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + fleets: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create a new Fleet for scoping of deployed devices within your + account. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id005 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Certificates: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Certificate credentials belonging to the + Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Filters the resulting list of Certificates by a unique string + identifier of an authenticated Device. + in: query + name: DeviceSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + certificates: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Enroll a new Certificate credential to the Fleet, optionally giving + it a friendly name and assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CertificateData: + description: Provides a URL encoded representation of the public + certificate in PEM format. + type: string + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + type: string + required: + - CertificateData + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: + delete: + description: Unregister a specific Certificate credential from the Fleet, effectively + disallowing any inbound client connections that are presenting it. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Certificate credential in the + Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Certificate credential + in the Fleet, giving it a friendly name or assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /DeployedDevices/Fleets/{FleetSid}/Deployments: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Deployments belonging to the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + deployments: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create a new Deployment in the Fleet, optionally giving it a friendly + name and linking to a specific Twilio Sync service instance. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: Provides a human readable descriptive text for this + Deployment, up to 256 characters long. + type: string + SyncServiceSid: + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: + delete: + description: Delete a specific Deployment from the Fleet, leaving associated + devices effectively undeployed. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Deployment in the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Deployment credential + in the Fleet, giving it a friendly name or linking to a specific Twilio Sync + service instance. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: Provides a human readable descriptive text for this + Deployment, up to 64 characters long + type: string + SyncServiceSid: + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /DeployedDevices/Fleets/{FleetSid}/Devices: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Devices belonging to the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Filters the resulting list of Devices by a unique string identifier + of the Deployment they are associated with. + in: query + name: DeploymentSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + devices: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + 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. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeploymentSid: + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + Enabled: + description: '' + type: boolean + FriendlyName: + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + type: string + Identity: + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + type: string + UniqueName: + 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. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id003 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: + delete: + description: Delete a specific Device from the Fleet, also removing it from + associated Deployments. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Device resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Device in the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Device resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Device in the Fleet, + giving it a friendly name, assigning to a Deployment, or a human identity. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Device resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeploymentSid: + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + Enabled: + description: '' + type: boolean + FriendlyName: + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + type: string + Identity: + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /DeployedDevices/Fleets/{FleetSid}/Keys: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Keys credentials belonging to the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Filters the resulting list of Keys by a unique string identifier + of an authenticated Device. + in: query + name: DeviceSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + keys: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create a new Key credential in the Fleet, optionally giving it + a friendly name and assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id004 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: + delete: + description: Delete a specific Key credential from the Fleet, effectively disallowing + any inbound client connections that are presenting it. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Key credential in the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Key credential in the + Fleet, giving it a friendly name or assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /DeployedDevices/Fleets/{Sid}: + delete: + description: 'Delete a specific Fleet from your account, also destroys all nested + resources: Devices, Deployments, Certificates, Keys.' + parameters: + - description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Fleet in your account. + parameters: + - description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the friendly name property of a specific Fleet in your account. + parameters: + - description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DefaultDeploymentSid: + description: Provides a string identifier of a Deployment that is + going to be used as a default one for this Fleet. + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id005 + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_hosted_numbers.yaml b/spec/yaml/twilio_preview_hosted_numbers.yaml new file mode 100644 index 00000000..93f0635c --- /dev/null +++ b/spec/yaml/twilio_preview_hosted_numbers.yaml @@ -0,0 +1,973 @@ +components: + schemas: + preview.hosted_numbers.authorization_document: + properties: + address_sid: + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + cc_emails: + items: + type: string + type: array + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + email: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + status: + enum: + - opened + - signing + - signed + - canceled + - failed + type: string + url: + format: uri + type: string + type: object + preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + address_sid: + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + call_delay: + type: integer + capabilities: + type: object + cc_emails: + items: + type: string + type: array + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + email: + type: string + extension: + type: string + failure_reason: + type: string + friendly_name: + type: string + incoming_phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + phone_number: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + signing_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + status: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + unique_name: + type: string + verification_attempts: + type: integer + verification_call_sids: + items: + type: string + type: array + verification_code: + type: string + verification_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + verification_type: + enum: + - phone-call + - phone-bill + type: string + type: object + preview.hosted_numbers.hosted_number_order: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + address_sid: + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + call_delay: + type: integer + capabilities: + type: object + cc_emails: + items: + type: string + type: array + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + email: + type: string + extension: + type: string + failure_reason: + type: string + friendly_name: + type: string + incoming_phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + phone_number: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + signing_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + status: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + unique_name: + type: string + url: + format: uri + type: string + verification_attempts: + type: integer + verification_call_sids: + items: + type: string + type: array + verification_code: + type: string + verification_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + verification_type: + enum: + - phone-call + - phone-bill + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /HostedNumbers/AuthorizationDocuments: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. + parameters: + - description: Email that this AuthorizationDocument will be sent to for signing. + in: query + name: Email + schema: + type: string + - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + in: query + name: Status + schema: + enum: + - opened + - signing + - signed + - canceled + - failed + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AddressSid: + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + CcEmails: + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + items: + type: string + type: array + ContactPhoneNumber: + description: The contact phone number of the person authorized to + sign the Authorization Document. + type: string + ContactTitle: + description: The title of the person authorized to sign the Authorization + Document for this phone number. + type: string + Email: + description: Email that this AuthorizationDocument will be sent + to for signing. + type: string + HostedNumberOrderSids: + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + items: + type: string + type: array + required: + - HostedNumberOrderSids + - AddressSid + - Email + - ContactTitle + - ContactPhoneNumber + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /HostedNumbers/AuthorizationDocuments/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific AuthorizationDocument. + parameters: + - description: A 34 character string that uniquely identifies this AuthorizationDocument. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates a specific AuthorizationDocument. + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AddressSid: + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + CcEmails: + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + items: + type: string + type: array + ContactPhoneNumber: + description: The contact phone number of the person authorized to + sign the Authorization Document. + type: string + ContactTitle: + description: The title of the person authorized to sign the Authorization + Document for this phone number. + type: string + Email: + description: Email that this AuthorizationDocument will be sent + to for signing. + type: string + HostedNumberOrderSids: + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + items: + type: string + type: array + 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/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + enum: + - opened + - signing + - signed + - canceled + - failed + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. + parameters: + - description: '' + in: path + name: SigningDocumentSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + in: query + name: Status + schema: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + - description: An E164 formatted phone number hosted by this HostedNumberOrder. + in: query + name: PhoneNumber + schema: + type: string + - description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + in: query + name: IncomingPhoneNumberSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + - description: A human readable description of this resource, up to 64 characters. + in: query + name: FriendlyName + schema: + 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. + in: query + name: UniqueName + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: list + /HostedNumbers/HostedNumberOrders: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. + parameters: + - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. + in: query + name: Status + schema: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + - description: An E164 formatted phone number hosted by this HostedNumberOrder. + in: query + name: PhoneNumber + schema: + type: string + - description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + in: query + name: IncomingPhoneNumberSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + - description: A human readable description of this resource, up to 64 characters. + in: query + name: FriendlyName + schema: + 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. + in: query + name: UniqueName + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Host a phone number's capability on Twilio's platform. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AccountSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + AddressSid: + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + CcEmails: + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + items: + type: string + type: array + Email: + description: Optional. Email of the owner of this phone number that + is being hosted. + type: string + FriendlyName: + description: A 64 character string that is a human readable text + that describes this resource. + type: string + PhoneNumber: + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + type: string + SmsApplicationSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + type: string + SmsCapability: + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + type: boolean + SmsFallbackMethod: + 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. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsFallbackUrl: + 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. + format: uri + type: string + SmsMethod: + 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. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsUrl: + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + format: uri + type: string + StatusCallbackMethod: + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + StatusCallbackUrl: + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + format: uri + type: string + UniqueName: + 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. + type: string + VerificationDocumentSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + VerificationType: + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + enum: + - phone-call + - phone-bill + type: string + required: + - PhoneNumber + - SmsCapability + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /HostedNumbers/HostedNumberOrders/{Sid}: + delete: + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). + parameters: + - description: A 34 character string that uniquely identifies this HostedNumberOrder. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific HostedNumberOrder. + parameters: + - description: A 34 character string that uniquely identifies this HostedNumberOrder. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates a specific HostedNumberOrder. + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallDelay: + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. + type: integer + CcEmails: + description: Optional. A list of emails that LOA document for this + HostedNumberOrder will be carbon copied to. + items: + type: string + type: array + Email: + description: Email of the owner of this phone number that is being + hosted. + type: string + Extension: + description: Digits to dial after connecting the verification call. + type: string + FriendlyName: + description: A 64 character string that is a human readable text + that describes this resource. + type: string + 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. + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + UniqueName: + 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. + type: string + VerificationCode: + description: A verification code that is given to the user via a + phone call to the phone number that is being hosted. + type: string + VerificationDocumentSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + VerificationType: + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + enum: + - phone-call + - phone-bill + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_marketplace.yaml b/spec/yaml/twilio_preview_marketplace.yaml new file mode 100644 index 00000000..9d3700f7 --- /dev/null +++ b/spec/yaml/twilio_preview_marketplace.yaml @@ -0,0 +1,636 @@ +components: + schemas: + preview.marketplace.available_add_on: + properties: + configuration_schema: + type: object + description: + type: string + friendly_name: + type: string + links: + type: object + pricing_type: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.marketplace.available_add_on.available_add_on_extension: + properties: + available_add_on_sid: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + friendly_name: + type: string + product_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.marketplace.installed_add_on: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + configuration: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + description: + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.marketplace.installed_add_on.installed_add_on_extension: + properties: + enabled: + type: boolean + friendly_name: + type: string + installed_add_on_sid: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + product_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /marketplace/AvailableAddOns: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Add-ons currently available to be installed. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + available_add_ons: + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Extensions for the Available Add-on. + parameters: + - description: The SID of the AvailableAddOn resource with the extensions to + read. + in: path + name: AvailableAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + extensions: + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Extension for the Available Add-on. + parameters: + - description: The SID of the AvailableAddOn resource with the extension to + fetch. + in: path + name: AvailableAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + - description: The SID of the AvailableAddOn Extension resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /marketplace/AvailableAddOns/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Add-on currently available to be installed. + parameters: + - description: The SID of the AvailableAddOn resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /marketplace/InstalledAddOns: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Add-ons currently installed on this Account. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + installed_add_ons: + items: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Install an Add-on for the Account specified. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AcceptTermsOfService: + description: Whether the Terms of Service were accepted. + type: boolean + AvailableAddOnSid: + description: The SID of the AvaliableAddOn to install. + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + Configuration: + description: The JSON object that represents the configuration of + the new Add-on being installed. + type: object + UniqueName: + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + type: string + required: + - AvailableAddOnSid + - AcceptTermsOfService + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id004 [] + x-path-type: list + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Extensions for the Installed Add-on. + parameters: + - description: The SID of the InstalledAddOn resource with the extensions to + read. + in: path + name: InstalledAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + extensions: + items: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id003 [] + x-path-type: list + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Extension for the Installed Add-on. + parameters: + - description: The SID of the InstalledAddOn resource with the extension to + fetch. + in: path + name: InstalledAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + - description: The SID of the InstalledAddOn Extension resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an Extension for an Add-on installation. + parameters: + - description: The SID of the InstalledAddOn resource with the extension to + update. + in: path + name: InstalledAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + - description: The SID of the InstalledAddOn Extension resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Enabled: + description: Whether the Extension should be invoked. + type: boolean + required: + - Enabled + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /marketplace/InstalledAddOns/{Sid}: + delete: + description: Remove an Add-on installation from your account + parameters: + - description: The SID of the InstalledAddOn resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Add-on currently installed on this Account. + parameters: + - description: The SID of the InstalledAddOn resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an Add-on installation for the Account specified. + parameters: + - description: The SID of the InstalledAddOn resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + 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 + type: object + UniqueName: + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id004 + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_sync.yaml b/spec/yaml/twilio_preview_sync.yaml new file mode 100644 index 00000000..1adcf73a --- /dev/null +++ b/spec/yaml/twilio_preview_sync.yaml @@ -0,0 +1,2139 @@ +components: + schemas: + preview.sync.service: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + acl_enabled: + type: boolean + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + reachability_webhooks_enabled: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + webhook_url: + format: uri + type: string + type: object + preview.sync.service.document: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + data: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + links: + type: object + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^ET[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service.document.document_permission: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + document_sid: + maxLength: 34 + minLength: 34 + pattern: ^ET[0-9a-fA-F]{32}$ + type: string + identity: + type: string + manage: + type: boolean + read: + type: boolean + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + write: + type: boolean + type: object + preview.sync.service.sync_list: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + links: + type: object + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_list.sync_list_item: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + data: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + index: + type: integer + list_sid: + maxLength: 34 + minLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ + type: string + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_list.sync_list_permission: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + identity: + type: string + list_sid: + maxLength: 34 + minLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ + type: string + manage: + type: boolean + read: + type: boolean + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + write: + type: boolean + type: object + preview.sync.service.sync_map: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + links: + type: object + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_map.sync_map_item: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + data: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + key: + type: string + map_sid: + maxLength: 34 + minLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ + type: string + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_map.sync_map_permission: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + identity: + type: string + manage: + type: boolean + map_sid: + maxLength: 34 + minLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ + type: string + read: + type: boolean + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + write: + type: boolean + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /Sync/Services: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + services: + items: + $ref: '#/components/schemas/preview.sync.service' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AclEnabled: + description: '' + type: boolean + FriendlyName: + description: '' + type: string + ReachabilityWebhooksEnabled: + description: '' + type: boolean + WebhookUrl: + description: '' + format: uri + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id009 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Documents: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + documents: + items: + $ref: '#/components/schemas/preview.sync.service.document' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Permissions applying to a Sync Document. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + permissions: + items: + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + delete: + description: Delete a specific Sync Document Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Sync Document Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an identity's access to a specific Sync Document. + parameters: + - description: The unique SID identifier of the Sync Service Instance. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Manage: + description: Boolean flag specifying whether the identity can delete + the Sync Document. + type: boolean + Read: + description: Boolean flag specifying whether the identity can read + the Sync Document. + type: boolean + Write: + description: Boolean flag specifying whether the identity can update + the Sync Document. + type: boolean + required: + - Read + - Write + - Manage + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /Sync/Services/{ServiceSid}/Documents/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /Sync/Services/{ServiceSid}/Lists: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + lists: + items: + $ref: '#/components/schemas/preview.sync.service.sync_list' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id005 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: query + name: Order + schema: + enum: + - asc + - desc + type: string + - description: '' + in: query + name: From + schema: + type: string + - description: '' + in: query + name: Bounds + schema: + enum: + - inclusive + - exclusive + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id003 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: path + name: Index + required: true + schema: + type: integer + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: path + name: Index + required: true + schema: + type: integer + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: path + name: Index + required: true + schema: + type: integer + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Permissions applying to a Sync List. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + permissions: + items: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id004 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + delete: + description: Delete a specific Sync List Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Sync List Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an identity's access to a specific Sync List. + parameters: + - description: The unique SID identifier of the Sync Service Instance. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Manage: + description: Boolean flag specifying whether the identity can delete + the Sync List. + type: boolean + Read: + description: Boolean flag specifying whether the identity can read + the Sync List. + type: boolean + Write: + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync List. + type: boolean + required: + - Read + - Write + - Manage + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /Sync/Services/{ServiceSid}/Lists/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id005 + x-path-type: instance + /Sync/Services/{ServiceSid}/Maps: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + maps: + items: + $ref: '#/components/schemas/preview.sync.service.sync_map' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id008 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: query + name: Order + schema: + enum: + - asc + - desc + type: string + - description: '' + in: query + name: From + schema: + type: string + - description: '' + in: query + name: Bounds + schema: + enum: + - inclusive + - exclusive + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + Key: + description: '' + type: string + required: + - Key + - Data + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id006 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: path + name: Key + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: path + name: Key + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: path + name: Key + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id006 + x-path-type: instance + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Permissions applying to a Sync Map. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + permissions: + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id007 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + delete: + description: Delete a specific Sync Map Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Sync Map Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an identity's access to a specific Sync Map. + parameters: + - description: The unique SID identifier of the Sync Service Instance. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Manage: + description: Boolean flag specifying whether the identity can delete + the Sync Map. + type: boolean + Read: + description: Boolean flag specifying whether the identity can read + the Sync Map. + type: boolean + Write: + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync Map. + type: boolean + required: + - Read + - Write + - Manage + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id007 + x-path-type: instance + /Sync/Services/{ServiceSid}/Maps/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id008 + x-path-type: instance + /Sync/Services/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AclEnabled: + description: '' + type: boolean + FriendlyName: + description: '' + type: string + ReachabilityWebhooksEnabled: + description: '' + type: boolean + WebhookUrl: + description: '' + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id009 + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_trusted_comms.yaml b/spec/yaml/twilio_preview_trusted_comms.yaml new file mode 100644 index 00000000..b494c026 --- /dev/null +++ b/spec/yaml/twilio_preview_trusted_comms.yaml @@ -0,0 +1,926 @@ +components: + schemas: + preview.trusted_comms.branded_call: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + bg_color: + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + branded_channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + call_sid: + maxLength: 34 + minLength: 34 + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + caller: + type: string + created_at: + format: date-time + type: string + font_color: + type: string + from: + type: string + logo: + type: string + phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + reason: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CQ[0-9a-fA-F]{32}$ + type: string + status: + type: string + to: + type: string + url: + format: uri + type: string + use_case: + type: string + type: object + preview.trusted_comms.branded_channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.branded_channel.channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + branded_channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + phone_number: + type: string + phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.brands_information: + properties: + file_link: + format: uri + type: string + file_link_ttl_in_seconds: + type: string + update_time: + format: date-time + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.business: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.business.insights: + properties: {} + type: object + preview.trusted_comms.business.insights.insights_impressions_rate: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + end: + format: date-time + type: string + interval: + enum: + - minute + - hour + - day + - week + - month + type: string + reports: + type: object + start: + format: date-time + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.cps: + properties: + cps_url: + format: uri + type: string + phone_number: + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.current_call: + properties: + bg_color: + type: string + caller: + type: string + created_at: + format: date-time + type: string + font_color: + type: string + from: + type: string + logo: + type: string + manager: + type: string + reason: + type: string + shield_img: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CQ[0-9a-fA-F]{32}$ + type: string + status: + type: string + to: + type: string + url: + format: uri + type: string + use_case: + type: string + type: object + preview.trusted_comms.phone_call: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + bg_color: + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + branded_channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + call_sid: + maxLength: 34 + minLength: 34 + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + caller: + type: string + created_at: + format: date-time + type: string + font_color: + type: string + from: + type: string + logo: + type: string + phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + reason: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CQ[0-9a-fA-F]{32}$ + type: string + status: + type: string + to: + type: string + url: + format: uri + type: string + use_case: + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels: + description: 'TODO: Resource-level docs' + post: + description: Associate a channel to a branded channel + parameters: + - description: The unique SID identifier of the Branded Channel. The given phone + number is going to be assigned to this Branded Channel + in: path + name: BrandedChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + PhoneNumberSid: + description: The unique SID identifier of the Phone Number of the + Phone number to be assigned to the Branded Channel. + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + required: + - PhoneNumberSid + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.branded_channel.channel' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - business_sid + - brand_sid + - branded_channel_sid + - phone_number_sid + - phone_number + - url + x-path-type: list + /TrustedComms/BrandedChannels/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Branded Channel. + parameters: + - description: The unique SID identifier of the Branded Channel. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.branded_channel' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - business_sid + - brand_sid + - sid + - links + - url + x-path-type: instance + /TrustedComms/BrandsInformation: + description: 'TODO: Resource-level docs' + get: + description: Retrieve the newest available BrandInformation + parameters: + - description: The If-None-Match HTTP request header + in: header + name: If-None-Match + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.brands_information' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - update_time + - file_link + - file_link_ttl_in_seconds + - url + x-path-type: instance + /TrustedComms/Business/BrandedCalls: + description: 'TODO: Resource-level docs' + post: + description: Brands a Call without actually placing it. Useful for cases when + the Customer wants to initiate the call themselves right after calling this + endpoint. This can be used also through a TwiML using `+1500456`, + and right after doing `+1500456` + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallSid: + description: The Call sid this Branded Call should link to. + maxLength: 34 + minLength: 34 + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + From: + description: The phone number to use as the caller id, given in + [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + It must be a Twilio number that has been set up as a Branded Number + in the Business Profile section for your account. + type: string + Reason: + description: The business reason for this phone call that will appear + in the terminating device's screen. Max 50 characters. + type: string + To: + description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + type: string + required: + - From + - To + - Reason + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.branded_call' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - bg_color + - brand_sid + - branded_channel_sid + - business_sid + - call_sid + - caller + - created_at + - font_color + - from + - logo + - phone_number_sid + - reason + - sid + - status + - to + - url + - use_case + x-path-type: list + /TrustedComms/Business/PhoneCalls: + description: 'TODO: Resource-level docs' + post: + description: Initiates a Branded Call. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ApplicationSid: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + maxLength: 34 + minLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + type: string + CallerId: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + FallbackMethod: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + FallbackUrl: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + format: uri + type: string + From: + description: The phone number to use as the caller id, given in + [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + It must be a Twilio number that has been set up as a Branded Number + in the Business Profile section for your account. + type: string + MachineDetection: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + MachineDetectionSilenceTimeout: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + MachineDetectionSpeechEndThreshold: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + MachineDetectionSpeechThreshold: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + MachineDetectionTimeout: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + Method: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Reason: + description: The business reason for this phone call that will appear + in the terminating device's screen. Max 50 characters. + type: string + Record: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: boolean + RecordingChannels: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + RecordingStatusCallback: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + RecordingStatusCallbackEvent: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + items: + type: string + type: array + RecordingStatusCallbackMethod: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SendDigits: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + SipAuthPassword: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + SipAuthUsername: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + StatusCallback: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + format: uri + type: string + StatusCallbackEvent: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + items: + type: string + type: array + StatusCallbackMethod: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Timeout: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + To: + description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + type: string + Trim: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + Url: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + format: uri + type: string + required: + - From + - To + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.phone_call' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - bg_color + - brand_sid + - branded_channel_sid + - business_sid + - call_sid + - caller + - created_at + - font_color + - from + - logo + - phone_number_sid + - reason + - sid + - status + - to + - url + - use_case + x-path-type: list + /TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Impressions Rate. + parameters: + - description: The unique SID identifier of the Business to filter by. + in: path + name: BusinessSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + - description: The unique SID identifier of the Brand to filter by. + in: query + name: BrandSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + - description: The unique SID identifier of the Branded Channel to filter by. + in: query + name: BrandedChannelSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + - description: The unique SID identifier of the Phone Number to filter by. + in: query + name: PhoneNumberSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + - description: The 2-letter ISO 3166 code of the Country to filter by. + in: query + name: Country + schema: + type: string + - description: The start date that for this Impressions Rate, given in ISO 8601 + format. Default value is 30 days ago. + in: query + name: Start + schema: + format: date-time + type: string + - description: The end date that for this Impressions Rate, given in ISO 8601 + format. Default value is current timestamp. + in: query + name: End + schema: + format: date-time + type: string + - description: The Interval of this Impressions Rate. One of `minute`, `hour`, + `day`, `week` or `month`. + in: query + name: Interval + schema: + enum: + - minute + - hour + - day + - week + - month + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - start + - end + - interval + - business_sid + - reports + - url + x-path-type: instance + /TrustedComms/Businesses/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Business. + parameters: + - description: A 34 character string that uniquely identifies this Business. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.business' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - sid + - url + - links + x-path-type: instance + /TrustedComms/CPS: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Call Placement Service (CPS) given a phone number + via `X-XCNAM-Sensitive-Phone-Number` header. + parameters: + - description: The X-Xcnam-Sensitive-Phone-Number HTTP request header + in: header + name: X-Xcnam-Sensitive-Phone-Number + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.cps' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - cps_url + - phone_number + - url + x-path-type: instance + /TrustedComms/CurrentCall: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a current call given the originating and terminating number + via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` + headers. + parameters: + - description: The X-Xcnam-Sensitive-Phone-Number-From HTTP request header + in: header + name: X-Xcnam-Sensitive-Phone-Number-From + schema: + type: string + - description: The X-Xcnam-Sensitive-Phone-Number-To HTTP request header + in: header + name: X-Xcnam-Sensitive-Phone-Number-To + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.current_call' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - bg_color + - caller + - created_at + - font_color + - from + - logo + - manager + - reason + - shield_img + - sid + - status + - to + - url + - use_case + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_understand.yaml b/spec/yaml/twilio_preview_understand.yaml new file mode 100644 index 00000000..e4e75756 --- /dev/null +++ b/spec/yaml/twilio_preview_understand.yaml @@ -0,0 +1,2389 @@ +components: + schemas: + preview.understand.assistant: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + callback_events: + type: string + callback_url: + format: uri + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + latest_model_build_sid: + maxLength: 34 + minLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + type: string + links: + type: object + log_queries: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.assistant_fallback_actions: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + url: + format: uri + type: string + type: object + preview.understand.assistant.assistant_initiation_actions: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + url: + format: uri + type: string + type: object + preview.understand.assistant.dialogue: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^UK[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.field_type: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.field_type.field_value: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + field_type_sid: + maxLength: 34 + minLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ + type: string + language: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ + type: string + synonym_of: + maxLength: 34 + minLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + value: + type: string + type: object + preview.understand.assistant.model_build: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + build_duration: + nullable: true + type: integer + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + error_code: + nullable: true + type: integer + sid: + maxLength: 34 + minLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + type: string + status: + enum: + - enqueued + - building + - completed + - failed + - canceled + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.query: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + language: + type: string + model_build_sid: + maxLength: 34 + minLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + type: string + query: + type: string + results: + type: object + sample_sid: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UH[0-9a-fA-F]{32}$ + type: string + source_channel: + type: string + status: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.style_sheet: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + url: + format: uri + type: string + type: object + preview.understand.assistant.task: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + actions_url: + format: uri + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.field: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + field_type: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UE[0-9a-fA-F]{32}$ + type: string + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.sample: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + language: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + source_channel: + type: string + tagged_text: + type: string + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.task_actions: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.task_statistics: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + fields_count: + type: integer + samples_count: + type: integer + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /understand/Assistants: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + assistants: + items: + $ref: '#/components/schemas/preview.understand.assistant' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackEvents: + description: Space-separated list of callback events that will trigger + callbacks. + type: string + CallbackUrl: + description: A user-provided URL to send event callbacks to. + format: uri + type: string + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + type: object + FriendlyName: + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + type: string + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + type: object + LogQueries: + description: A boolean that specifies whether queries should be + logged for 30 days further training. If false, no queries will + be stored, if true, queries will be stored for 30 days and deleted + thereafter. Defaults to true if no value is provided. + type: boolean + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + type: object + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id008 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.dialogue' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/FallbackActions: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FallbackActions: + description: '' + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/FieldTypes: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + field_types: + items: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - UniqueName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + - description: 'An ISO language-country string of the value. For example: *en-US*' + in: query + name: Language + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + field_values: + items: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Language: + description: An ISO language-country string of the value. + type: string + SynonymOf: + description: A value that indicates this field value is a synonym + of. Empty if the value is not a synonym. + type: string + Value: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - Language + - Value + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /understand/Assistants/{AssistantSid}/InitiationActions: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + InitiationActions: + description: '' + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/ModelBuilds: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + model_builds: + items: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + StatusCallback: + description: '' + format: uri + type: string + UniqueName: + description: 'A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. For example: v0.1' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id003 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + UniqueName: + description: 'A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. For example: v0.1' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Queries: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: An ISO language-country string of the sample. + in: query + name: Language + schema: + type: string + - description: The Model Build Sid or unique name of the Model Build to be queried. + in: query + name: ModelBuild + schema: + type: string + - description: 'A string that described the query status. The values can be: + pending_review, reviewed, discarded' + in: query + name: Status + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + queries: + items: + $ref: '#/components/schemas/preview.understand.assistant.query' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Field: + description: Constraints the query to a given Field with an task. + Useful when you know the Field you are expecting. It accepts one + field in the format *task-unique-name-1*:*field-unique-name* + type: string + Language: + description: An ISO language-country string of the sample. + type: string + ModelBuild: + description: The Model Build Sid or unique name of the Model Build + to be queried. + type: string + Query: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. It can be up to 2048 characters + long. + type: string + Tasks: + description: Constraints the query to a set of tasks. Useful when + you need to constrain the paths the user can take. Tasks should + be comma separated *task-unique-name-1*, *task-unique-name-2* + type: string + required: + - Language + - Query + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id004 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Queries/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + SampleSid: + description: An optional reference to the Sample created from this + query. + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + Status: + description: 'A string that described the query status. The values + can be: pending_review, reviewed, discarded' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /understand/Assistants/{AssistantSid}/StyleSheet: + description: 'TODO: Resource-level docs' + get: + description: Returns Style sheet JSON object for this Assistant + parameters: + - description: The unique ID of the Assistant + in: path + name: AssistantSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates the style sheet for an assistant identified by {AssistantSid} + or {AssistantUniqueName}. + parameters: + - description: The unique ID of the Assistant + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + StyleSheet: + description: The JSON Style sheet string + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + tasks: + items: + $ref: '#/components/schemas/preview.understand.assistant.task' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + type: object + ActionsUrl: + description: User-provided HTTP endpoint where from the assistant + fetches actions + format: uri + type: string + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - UniqueName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id005 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Tasks/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + type: object + ActionsUrl: + description: User-provided HTTP endpoint where from the assistant + fetches actions + format: uri + type: string + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id005 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: + description: 'TODO: Resource-level docs' + get: + description: Returns JSON actions for this Task. + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task. + in: path + name: TaskSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task. + in: path + name: TaskSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Actions: + description: The JSON actions that instruct the Assistant how to + perform this task. + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + fields: + items: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FieldType: + description: The unique name or sid of the FieldType. It can be + any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) + or the unique_name or the Field Type sid of a custom Field Type. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - FieldType + - UniqueName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id006 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id006 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: An ISO language-country string of the sample. + in: query + name: Language + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + samples: + items: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Language: + description: An ISO language-country string of the sample. + type: string + SourceChannel: + description: 'The communication channel the sample was captured. + It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, + or *slack*. If not included the value will be null' + type: string + TaggedText: + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + type: string + required: + - Language + - TaggedText + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id007 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Language: + description: An ISO language-country string of the sample. + type: string + SourceChannel: + description: 'The communication channel the sample was captured. + It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, + or *slack*. If not included the value will be null' + type: string + TaggedText: + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id007 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{Sid}: + delete: + description: '' + parameters: + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackEvents: + description: Space-separated list of callback events that will trigger + callbacks. + type: string + CallbackUrl: + description: A user-provided URL to send event callbacks to. + format: uri + type: string + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + type: object + FriendlyName: + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + type: string + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + type: object + LogQueries: + description: A boolean that specifies whether queries should be + logged for 30 days further training. If false, no queries will + be stored, if true, queries will be stored for 30 days and deleted + thereafter. Defaults to true if no value is provided. + type: boolean + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + type: object + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id008 + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_preview_wireless.yaml b/spec/yaml/twilio_preview_wireless.yaml new file mode 100644 index 00000000..1fa64779 --- /dev/null +++ b/spec/yaml/twilio_preview_wireless.yaml @@ -0,0 +1,862 @@ +components: + schemas: + preview.wireless.command: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + command: + type: string + command_mode: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + device_sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + direction: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ + type: string + sim_sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + status: + type: string + url: + format: uri + type: string + type: object + preview.wireless.rate_plan: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + data_enabled: + type: boolean + data_limit: + type: integer + data_metering: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + international_roaming: + items: + type: string + type: array + messaging_enabled: + type: boolean + national_roaming_enabled: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + voice_enabled: + type: boolean + type: object + preview.wireless.sim: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + commands_callback_method: + type: string + commands_callback_url: + format: uri + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + e_id: + type: string + friendly_name: + type: string + iccid: + type: string + links: + type: object + rate_plan_sid: + maxLength: 34 + minLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + sms_fallback_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + sms_fallback_url: + format: uri + type: string + sms_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + sms_url: + format: uri + type: string + status: + type: string + unique_name: + type: string + url: + format: uri + type: string + voice_fallback_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + voice_fallback_url: + format: uri + type: string + voice_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + voice_url: + format: uri + type: string + type: object + preview.wireless.sim.usage: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + commands_costs: + type: object + commands_usage: + type: object + data_costs: + type: object + data_usage: + type: object + period: + type: object + sim_sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + sim_unique_name: + type: string + url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 5.12.0 +openapi: 3.0.1 +paths: + /wireless/Commands: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: query + name: Device + schema: + type: string + - description: '' + in: query + name: Sim + schema: + type: string + - description: '' + in: query + name: Status + schema: + type: string + - description: '' + in: query + name: Direction + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + commands: + items: + $ref: '#/components/schemas/preview.wireless.command' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackMethod: + description: '' + type: string + CallbackUrl: + description: '' + format: uri + type: string + Command: + description: '' + type: string + CommandMode: + description: '' + type: string + Device: + description: '' + type: string + IncludeSid: + description: '' + type: string + Sim: + description: '' + type: string + required: + - Command + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.command' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /wireless/Commands/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.command' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /wireless/RatePlans: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + rate_plans: + items: + $ref: '#/components/schemas/preview.wireless.rate_plan' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CommandsEnabled: + description: '' + type: boolean + DataEnabled: + description: '' + type: boolean + DataLimit: + description: '' + type: integer + DataMetering: + description: '' + type: string + FriendlyName: + description: '' + type: string + InternationalRoaming: + description: '' + items: + type: string + type: array + MessagingEnabled: + description: '' + type: boolean + NationalRoamingEnabled: + description: '' + type: boolean + UniqueName: + description: '' + type: string + VoiceEnabled: + description: '' + type: boolean + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /wireless/RatePlans/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: '' + type: string + UniqueName: + description: '' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /wireless/Sims: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: query + name: Status + schema: + type: string + - description: '' + in: query + name: Iccid + schema: + type: string + - description: '' + in: query + name: RatePlan + schema: + type: string + - description: '' + in: query + name: EId + schema: + type: string + - description: '' + in: query + name: SimRegistrationCode + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + sims: + items: + $ref: '#/components/schemas/preview.wireless.sim' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id003 [] + x-path-type: list + /wireless/Sims/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackMethod: + description: '' + type: string + CallbackUrl: + description: '' + format: uri + type: string + CommandsCallbackMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + CommandsCallbackUrl: + description: '' + format: uri + type: string + FriendlyName: + description: '' + type: string + RatePlan: + description: '' + type: string + SmsFallbackMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsFallbackUrl: + description: '' + format: uri + type: string + SmsMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsUrl: + description: '' + format: uri + type: string + Status: + description: '' + type: string + UniqueName: + description: '' + type: string + VoiceFallbackMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + VoiceFallbackUrl: + description: '' + format: uri + type: string + VoiceMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + VoiceUrl: + description: '' + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /wireless/Sims/{SimSid}/Usage: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: SimSid + required: true + schema: + type: string + - description: '' + in: query + name: End + schema: + type: string + - description: '' + in: query + name: Start + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim.usage' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview diff --git a/spec/yaml/twilio_pricing.yaml b/spec/yaml/twilio_pricing_v1.yaml similarity index 67% rename from spec/yaml/twilio_pricing.yaml rename to spec/yaml/twilio_pricing_v1.yaml index 948ade6e..10005619 100644 --- a/spec/yaml/twilio_pricing.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -196,106 +196,6 @@ components: format: uri type: string type: object - pricing.v2.voice: - properties: - links: - type: object - name: - type: string - url: - format: uri - type: string - type: object - pricing.v2.voice.voice_country: - properties: - country: - type: string - iso_country: - type: string - url: - format: uri - type: string - type: object - pricing.v2.voice.voice_country|instance: - properties: - country: - type: string - inbound_call_prices: - items: - properties: - base_price: - type: number - current_price: - type: number - number_type: - type: string - type: object - type: array - iso_country: - type: string - outbound_prefix_prices: - items: - properties: - base_price: - type: number - current_price: - type: number - destination_prefixes: - items: - type: string - type: array - friendly_name: - type: string - origination_prefixes: - items: - type: string - type: array - type: object - type: array - price_unit: - type: string - url: - format: uri - type: string - type: object - pricing.v2.voice.voice_number: - properties: - country: - type: string - destination_number: - type: string - inbound_call_price: - properties: - base_price: - type: number - current_price: - type: number - number_type: - type: string - type: object - iso_country: - type: string - origination_number: - type: string - outbound_call_prices: - items: - properties: - base_price: - type: number - current_price: - type: number - origination_prefixes: - items: - type: string - type: array - type: object - type: array - price_unit: - type: string - url: - format: uri - type: string - type: object securitySchemes: accountSid_authToken: scheme: basic @@ -311,7 +211,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Messaging/Countries: @@ -595,128 +495,6 @@ paths: - inbound_call_price - price_unit x-path-type: instance - /v2/Voice/Countries: - description: Voice pricing by country - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - countries: - items: - $ref: '#/components/schemas/pricing.v2.voice.voice_country' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://pricing.twilio.com - x-default-output-properties: &id004 - - country - - price_unit - x-path-type: list - /v2/Voice/Countries/{IsoCountry}: - description: Voice pricing by country - get: - description: Fetch a specific Country. - parameters: - - description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - of the origin-based voice pricing information to fetch. - in: path - name: IsoCountry - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/pricing.v2.voice.voice_country|instance' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://pricing.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /v2/Voice/Numbers/{DestinationNumber}: - description: Voice pricing for a specific phone number - get: - description: Fetch pricing information for a specific destination and, optionally, - origination phone number. - parameters: - - description: The destination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) - format, for which to fetch the origin-based voice pricing information. E.164 - format consists of a + followed by the country code and subscriber number. - in: path - name: DestinationNumber - required: true - schema: - type: string - - description: The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) - format, for which to fetch the origin-based voice pricing information. E.164 - format consists of a + followed by the country code and subscriber number. - in: query - name: OriginationNumber - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/pricing.v2.voice.voice_number' - description: OK - security: - - accountSid_authToken: [] - tags: - - GA - servers: - - url: https://pricing.twilio.com - x-default-output-properties: - - country - - inbound_call_price - - price_unit - x-path-type: instance tags: - description: This product is Generally Available. name: GA diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml new file mode 100644 index 00000000..d0ffa8b8 --- /dev/null +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -0,0 +1,245 @@ +components: + schemas: + pricing.v2.voice: + properties: + links: + type: object + name: + type: string + url: + format: uri + type: string + type: object + pricing.v2.voice.voice_country: + properties: + country: + type: string + iso_country: + type: string + url: + format: uri + type: string + type: object + pricing.v2.voice.voice_country|instance: + properties: + country: + type: string + inbound_call_prices: + items: + properties: + base_price: + type: number + current_price: + type: number + number_type: + type: string + type: object + type: array + iso_country: + type: string + outbound_prefix_prices: + items: + properties: + base_price: + type: number + current_price: + type: number + destination_prefixes: + items: + type: string + type: array + friendly_name: + type: string + origination_prefixes: + items: + type: string + type: array + type: object + type: array + price_unit: + type: string + url: + format: uri + type: string + type: object + pricing.v2.voice.voice_number: + properties: + country: + type: string + destination_number: + type: string + inbound_call_price: + properties: + base_price: + type: number + current_price: + type: number + number_type: + type: string + type: object + iso_country: + type: string + origination_number: + type: string + outbound_call_prices: + items: + properties: + base_price: + type: number + current_price: + type: number + origination_prefixes: + items: + type: string + type: array + type: object + type: array + price_unit: + type: string + url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Pricing + version: 5.12.0 +openapi: 3.0.1 +paths: + /v2/Voice/Countries: + description: Voice pricing by country + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + countries: + items: + $ref: '#/components/schemas/pricing.v2.voice.voice_country' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://pricing.twilio.com + x-default-output-properties: &id001 + - country + - price_unit + x-path-type: list + /v2/Voice/Countries/{IsoCountry}: + description: Voice pricing by country + get: + description: Fetch a specific Country. + parameters: + - description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of the origin-based voice pricing information to fetch. + in: path + name: IsoCountry + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/pricing.v2.voice.voice_country|instance' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://pricing.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /v2/Voice/Numbers/{DestinationNumber}: + description: Voice pricing for a specific phone number + get: + description: Fetch pricing information for a specific destination and, optionally, + origination phone number. + parameters: + - description: The destination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format, for which to fetch the origin-based voice pricing information. E.164 + format consists of a + followed by the country code and subscriber number. + in: path + name: DestinationNumber + required: true + schema: + type: string + - description: The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format, for which to fetch the origin-based voice pricing information. E.164 + format consists of a + followed by the country code and subscriber number. + in: query + name: OriginationNumber + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/pricing.v2.voice.voice_number' + description: OK + security: + - accountSid_authToken: [] + tags: + - GA + servers: + - url: https://pricing.twilio.com + x-default-output-properties: + - country + - inbound_call_price + - price_unit + x-path-type: instance +tags: +- description: This product is Generally Available. + name: GA diff --git a/spec/yaml/twilio_proxy.yaml b/spec/yaml/twilio_proxy_v1.yaml similarity index 99% rename from spec/yaml/twilio_proxy.yaml rename to spec/yaml/twilio_proxy_v1.yaml index e5c78019..e3fb7c09 100644 --- a/spec/yaml/twilio_proxy.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -493,7 +493,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Proxy - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_serverless.yaml b/spec/yaml/twilio_serverless_v1.yaml similarity index 99% rename from spec/yaml/twilio_serverless.yaml rename to spec/yaml/twilio_serverless_v1.yaml index e8d1f250..3e14bc39 100644 --- a/spec/yaml/twilio_serverless.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -457,7 +457,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Serverless - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_studio.yaml b/spec/yaml/twilio_studio_v1.yaml similarity index 54% rename from spec/yaml/twilio_studio.yaml rename to spec/yaml/twilio_studio_v1.yaml index 0e93beaf..f108cf54 100644 --- a/spec/yaml/twilio_studio.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -305,248 +305,6 @@ components: format: uri type: string type: object - studio.v2.flow: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - commit_message: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - definition: - type: object - errors: - items: - type: object - type: array - friendly_name: - type: string - links: - type: object - revision: - type: integer - sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - status: - enum: - - draft - - published - type: string - url: - format: uri - type: string - valid: - type: boolean - warnings: - items: - type: object - type: array - webhook_url: - format: uri - type: string - type: object - studio.v2.flow.execution: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - contact_channel_address: - type: string - context: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - flow_sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - status: - enum: - - active - - ended - type: string - url: - format: uri - type: string - type: object - studio.v2.flow.execution.execution_context: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - context: - type: object - execution_sid: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - flow_sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - studio.v2.flow.execution.execution_step: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - context: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - execution_sid: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - flow_sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - links: - type: object - name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^FT[0-9a-fA-F]{32}$ - type: string - transitioned_from: - type: string - transitioned_to: - type: string - url: - format: uri - type: string - type: object - studio.v2.flow.execution.execution_step.execution_step_context: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - context: - type: object - execution_sid: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - flow_sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - step_sid: - maxLength: 34 - minLength: 34 - pattern: ^FT[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - studio.v2.flow.flow_revision: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - commit_message: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - definition: - type: object - errors: - items: - type: object - type: array - friendly_name: - type: string - revision: - type: integer - sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - status: - enum: - - draft - - published - type: string - url: - format: uri - type: string - valid: - type: boolean - type: object - studio.v2.flow.test_user: - properties: - sid: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - test_users: - items: - type: string - type: array - url: - format: uri - type: string - type: object - studio.v2.flow_validate: - properties: - valid: - type: boolean - type: object securitySchemes: accountSid_authToken: scheme: basic @@ -562,7 +320,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Flows: @@ -1516,863 +1274,6 @@ paths: - url: https://studio.twilio.com x-default-output-properties: *id005 x-path-type: instance - /v2/Flows: - description: Studio flows - get: - description: Retrieve a list of all Flows. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - flows: - items: - $ref: '#/components/schemas/studio.v2.flow' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - post: - description: Create a Flow. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CommitMessage: - description: Description on change made in the revision. - type: string - Definition: - description: JSON representation of flow definition. - type: object - FriendlyName: - description: The string that you assigned to describe the Flow. - type: string - Status: - description: 'The status of the Flow. Can be: `draft` or `published`.' - enum: - - draft - - published - type: string - required: - - FriendlyName - - Status - - Definition - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow' - description: Created - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: &id008 - - sid - - friendly_name - - status - - revision - x-path-type: list - /v2/Flows/Validate: - description: 'TODO: Resource-level docs' - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CommitMessage: - description: '' - type: string - Definition: - description: '' - type: object - FriendlyName: - description: '' - type: string - Status: - description: '' - enum: - - draft - - published - type: string - required: - - FriendlyName - - Status - - Definition - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow_validate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: - - valid - x-path-type: list - /v2/Flows/{FlowSid}/Executions: - description: Executions of Studio flows - get: - description: Retrieve a list of all Executions for the Flow. - parameters: - - description: The SID of the Flow with the Execution resources to read. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: Only show Execution resources starting on or after this [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`. - in: query - name: DateCreatedFrom - schema: - format: date-time - type: string - - description: Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`. - in: query - name: DateCreatedTo - schema: - format: date-time - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - executions: - items: - $ref: '#/components/schemas/studio.v2.flow.execution' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - post: - description: Triggers a new Execution for the Flow - parameters: - - description: The SID of the Excecution's Flow. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - From: - description: The Twilio phone number to send messages or initiate - calls from during the Flow's Execution. Available as variable - `{{flow.channel.address}}`. - type: string - Parameters: - description: 'JSON data that will be added to the Flow''s context - and that can be accessed as variables inside your Flow. For example, - if you pass in `Parameters={"name":"Zeke"}`, a widget in your - Flow can reference the variable `{{flow.data.name}}`, which returns - "Zeke". Note: the JSON value must explicitly be passed as a string, - not as a hash object. Depending on your particular HTTP library, - you may need to add quotes or URL encode the JSON string.' - type: object - To: - description: The Contact phone number to start a Studio Flow Execution, - available as variable `{{contact.channel.address}}`. - type: string - required: - - To - - From - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.execution' - description: Created - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: &id007 - - sid - - status - - date_created - x-path-type: list - /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: - description: JSON context for executions - get: - description: Retrieve the most recent context for an Execution. - parameters: - - description: The SID of the Flow with the Execution context to fetch. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution context to fetch. - in: path - name: ExecutionSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.execution.execution_context' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: - - context - x-path-type: instance - /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: - description: Individual steps within an execution - get: - description: Retrieve a list of all Steps for an Execution. - parameters: - - description: The SID of the Flow with the Steps to read. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution with the Steps to read. - in: path - name: ExecutionSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - steps: - items: - $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: &id006 - - sid - - name - - date_created - x-path-type: list - /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: - description: Individual steps within an execution - get: - description: Retrieve a Step. - parameters: - - description: The SID of the Flow with the Step to fetch. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution resource with the Step to fetch. - in: path - name: ExecutionSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - - description: The SID of the ExecutionStep resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FT[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: *id006 - x-path-type: instance - /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: - description: JSON context for an individual step within an execution - get: - description: Retrieve the context for an Execution Step. - parameters: - - description: The SID of the Flow with the Step to fetch. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution resource with the Step to fetch. - in: path - name: ExecutionSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Step to fetch. - in: path - name: StepSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FT[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: - - context - x-path-type: instance - /v2/Flows/{FlowSid}/Executions/{Sid}: - delete: - description: Delete the Execution and all Steps relating to it. - parameters: - - description: The SID of the Flow with the Execution resources to delete. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Beta - description: Executions of Studio flows - get: - description: Retrieve an Execution - parameters: - - description: The SID of the Flow with the Execution resource to fetch - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.execution' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - post: - description: Update the status of an Execution to `ended`. - parameters: - - description: The SID of the Flow with the Execution resources to update. - in: path - name: FlowSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: The SID of the Execution resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FN[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Status: - description: The status of the Execution. Can only be `ended`. - enum: - - active - - ended - type: string - required: - - Status - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.execution' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: *id007 - x-path-type: instance - /v2/Flows/{Sid}: - delete: - description: Delete a specific Flow. - parameters: - - description: The SID of the Flow resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Beta - description: Studio flows - get: - description: Retrieve a specific Flow. - parameters: - - description: The SID of the Flow resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - post: - description: Update a Flow. - parameters: - - description: The SID of the Flow resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CommitMessage: - description: Description on change made in the revision. - type: string - Definition: - description: JSON representation of flow definition. - type: object - FriendlyName: - description: The string that you assigned to describe the Flow. - type: string - Status: - description: 'The status of the Flow. Can be: `draft` or `published`.' - enum: - - draft - - published - type: string - required: - - Status - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: *id008 - x-path-type: instance - /v2/Flows/{Sid}/Revisions: - description: Studio flows revisions - get: - description: Retrieve a list of all Flows revisions. - parameters: - - description: The SID of the Flow resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - revisions: - items: - $ref: '#/components/schemas/studio.v2.flow.flow_revision' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: &id009 - - sid - - friendly_name - - status - - revision - x-path-type: list - /v2/Flows/{Sid}/Revisions/{Revision}: - description: Studio flows revisions - get: - description: Retrieve a specific Flow revision. - parameters: - - description: The SID of the Flow resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - - description: Specific Revision number or can be `LatestPublished` and `LatestRevision`. - in: path - name: Revision - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.flow_revision' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: *id009 - x-path-type: instance - /v2/Flows/{Sid}/TestUsers: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.test_user' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - TestUsers: - description: '' - items: - type: string - type: array - required: - - TestUsers - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/studio.v2.flow.test_user' - description: OK - security: - - accountSid_authToken: [] - tags: - - Beta - servers: - - url: https://studio.twilio.com - x-default-output-properties: - - test_users - x-path-type: instance tags: - description: This product is Generally Available. name: GA -- description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. - name: Beta diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml new file mode 100644 index 00000000..afe19eb1 --- /dev/null +++ b/spec/yaml/twilio_studio_v2.yaml @@ -0,0 +1,1120 @@ +components: + schemas: + studio.v2.flow: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + commit_message: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + definition: + type: object + errors: + items: + type: object + type: array + friendly_name: + type: string + links: + type: object + revision: + type: integer + sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + status: + enum: + - draft + - published + type: string + url: + format: uri + type: string + valid: + type: boolean + warnings: + items: + type: object + type: array + webhook_url: + format: uri + type: string + type: object + studio.v2.flow.execution: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + contact_channel_address: + type: string + context: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + flow_sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + status: + enum: + - active + - ended + type: string + url: + format: uri + type: string + type: object + studio.v2.flow.execution.execution_context: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + context: + type: object + execution_sid: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + flow_sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + studio.v2.flow.execution.execution_step: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + context: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + execution_sid: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + flow_sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + links: + type: object + name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^FT[0-9a-fA-F]{32}$ + type: string + transitioned_from: + type: string + transitioned_to: + type: string + url: + format: uri + type: string + type: object + studio.v2.flow.execution.execution_step.execution_step_context: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + context: + type: object + execution_sid: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + flow_sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + step_sid: + maxLength: 34 + minLength: 34 + pattern: ^FT[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + studio.v2.flow.flow_revision: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + commit_message: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + definition: + type: object + errors: + items: + type: object + type: array + friendly_name: + type: string + revision: + type: integer + sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + status: + enum: + - draft + - published + type: string + url: + format: uri + type: string + valid: + type: boolean + type: object + studio.v2.flow.test_user: + properties: + sid: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + test_users: + items: + type: string + type: array + url: + format: uri + type: string + type: object + studio.v2.flow_validate: + properties: + valid: + type: boolean + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Studio + version: 5.12.0 +openapi: 3.0.1 +paths: + /v2/Flows: + description: Studio flows + get: + description: Retrieve a list of all Flows. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + flows: + items: + $ref: '#/components/schemas/studio.v2.flow' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + post: + description: Create a Flow. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CommitMessage: + description: Description on change made in the revision. + type: string + Definition: + description: JSON representation of flow definition. + type: object + FriendlyName: + description: The string that you assigned to describe the Flow. + type: string + Status: + description: 'The status of the Flow. Can be: `draft` or `published`.' + enum: + - draft + - published + type: string + required: + - FriendlyName + - Status + - Definition + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow' + description: Created + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: &id003 + - sid + - friendly_name + - status + - revision + x-path-type: list + /v2/Flows/Validate: + description: 'TODO: Resource-level docs' + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CommitMessage: + description: '' + type: string + Definition: + description: '' + type: object + FriendlyName: + description: '' + type: string + Status: + description: '' + enum: + - draft + - published + type: string + required: + - FriendlyName + - Status + - Definition + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow_validate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: + - valid + x-path-type: list + /v2/Flows/{FlowSid}/Executions: + description: Executions of Studio flows + get: + description: Retrieve a list of all Executions for the Flow. + parameters: + - description: The SID of the Flow with the Execution resources to read. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: Only show Execution resources starting on or after this [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`. + in: query + name: DateCreatedFrom + schema: + format: date-time + type: string + - description: Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`. + in: query + name: DateCreatedTo + schema: + format: date-time + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + executions: + items: + $ref: '#/components/schemas/studio.v2.flow.execution' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + post: + description: Triggers a new Execution for the Flow + parameters: + - description: The SID of the Excecution's Flow. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + From: + description: The Twilio phone number to send messages or initiate + calls from during the Flow's Execution. Available as variable + `{{flow.channel.address}}`. + type: string + Parameters: + description: 'JSON data that will be added to the Flow''s context + and that can be accessed as variables inside your Flow. For example, + if you pass in `Parameters={"name":"Zeke"}`, a widget in your + Flow can reference the variable `{{flow.data.name}}`, which returns + "Zeke". Note: the JSON value must explicitly be passed as a string, + not as a hash object. Depending on your particular HTTP library, + you may need to add quotes or URL encode the JSON string.' + type: object + To: + description: The Contact phone number to start a Studio Flow Execution, + available as variable `{{contact.channel.address}}`. + type: string + required: + - To + - From + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.execution' + description: Created + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: &id002 + - sid + - status + - date_created + x-path-type: list + /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: + description: JSON context for executions + get: + description: Retrieve the most recent context for an Execution. + parameters: + - description: The SID of the Flow with the Execution context to fetch. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution context to fetch. + in: path + name: ExecutionSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.execution.execution_context' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: + - context + x-path-type: instance + /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: + description: Individual steps within an execution + get: + description: Retrieve a list of all Steps for an Execution. + parameters: + - description: The SID of the Flow with the Steps to read. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution with the Steps to read. + in: path + name: ExecutionSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + steps: + items: + $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: &id001 + - sid + - name + - date_created + x-path-type: list + /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: + description: Individual steps within an execution + get: + description: Retrieve a Step. + parameters: + - description: The SID of the Flow with the Step to fetch. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution resource with the Step to fetch. + in: path + name: ExecutionSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + - description: The SID of the ExecutionStep resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FT[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: + description: JSON context for an individual step within an execution + get: + description: Retrieve the context for an Execution Step. + parameters: + - description: The SID of the Flow with the Step to fetch. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution resource with the Step to fetch. + in: path + name: ExecutionSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Step to fetch. + in: path + name: StepSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FT[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: + - context + x-path-type: instance + /v2/Flows/{FlowSid}/Executions/{Sid}: + delete: + description: Delete the Execution and all Steps relating to it. + parameters: + - description: The SID of the Flow with the Execution resources to delete. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Beta + description: Executions of Studio flows + get: + description: Retrieve an Execution + parameters: + - description: The SID of the Flow with the Execution resource to fetch + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.execution' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + post: + description: Update the status of an Execution to `ended`. + parameters: + - description: The SID of the Flow with the Execution resources to update. + in: path + name: FlowSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: The SID of the Execution resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FN[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Status: + description: The status of the Execution. Can only be `ended`. + enum: + - active + - ended + type: string + required: + - Status + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.execution' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /v2/Flows/{Sid}: + delete: + description: Delete a specific Flow. + parameters: + - description: The SID of the Flow resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Beta + description: Studio flows + get: + description: Retrieve a specific Flow. + parameters: + - description: The SID of the Flow resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + post: + description: Update a Flow. + parameters: + - description: The SID of the Flow resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CommitMessage: + description: Description on change made in the revision. + type: string + Definition: + description: JSON representation of flow definition. + type: object + FriendlyName: + description: The string that you assigned to describe the Flow. + type: string + Status: + description: 'The status of the Flow. Can be: `draft` or `published`.' + enum: + - draft + - published + type: string + required: + - Status + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /v2/Flows/{Sid}/Revisions: + description: Studio flows revisions + get: + description: Retrieve a list of all Flows revisions. + parameters: + - description: The SID of the Flow resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + revisions: + items: + $ref: '#/components/schemas/studio.v2.flow.flow_revision' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: &id004 + - sid + - friendly_name + - status + - revision + x-path-type: list + /v2/Flows/{Sid}/Revisions/{Revision}: + description: Studio flows revisions + get: + description: Retrieve a specific Flow revision. + parameters: + - description: The SID of the Flow resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + - description: Specific Revision number or can be `LatestPublished` and `LatestRevision`. + in: path + name: Revision + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.flow_revision' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /v2/Flows/{Sid}/TestUsers: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.test_user' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + TestUsers: + description: '' + items: + type: string + type: array + required: + - TestUsers + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/studio.v2.flow.test_user' + description: OK + security: + - accountSid_authToken: [] + tags: + - Beta + servers: + - url: https://studio.twilio.com + x-default-output-properties: + - test_users + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Beta product that is subject to change. + Use it with caution. + name: Beta diff --git a/spec/yaml/twilio_supersim.yaml b/spec/yaml/twilio_supersim_v1.yaml similarity index 99% rename from spec/yaml/twilio_supersim.yaml rename to spec/yaml/twilio_supersim_v1.yaml index 0587b7da..c87dc621 100644 --- a/spec/yaml/twilio_supersim.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -255,7 +255,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Supersim - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Commands: diff --git a/spec/yaml/twilio_sync.yaml b/spec/yaml/twilio_sync_v1.yaml similarity index 99% rename from spec/yaml/twilio_sync.yaml rename to spec/yaml/twilio_sync_v1.yaml index a477a1bb..a4d184c4 100644 --- a/spec/yaml/twilio_sync.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -381,7 +381,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Sync - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_taskrouter.yaml b/spec/yaml/twilio_taskrouter_v1.yaml similarity index 99% rename from spec/yaml/twilio_taskrouter.yaml rename to spec/yaml/twilio_taskrouter_v1.yaml index 1bdacb55..9f5bbe81 100644 --- a/spec/yaml/twilio_taskrouter.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1041,7 +1041,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Taskrouter - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Workspaces: diff --git a/spec/yaml/twilio_trunking.yaml b/spec/yaml/twilio_trunking_v1.yaml similarity index 99% rename from spec/yaml/twilio_trunking.yaml rename to spec/yaml/twilio_trunking_v1.yaml index cf9567db..ce131e5f 100644 --- a/spec/yaml/twilio_trunking.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -347,7 +347,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Trunking - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Trunks: diff --git a/spec/yaml/twilio_verify.yaml b/spec/yaml/twilio_verify_v2.yaml similarity index 99% rename from spec/yaml/twilio_verify.yaml rename to spec/yaml/twilio_verify_v2.yaml index af4622bc..6806b83e 100644 --- a/spec/yaml/twilio_verify.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -455,7 +455,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Verify - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/Forms/{FormType}: diff --git a/spec/yaml/twilio_video.yaml b/spec/yaml/twilio_video_v1.yaml similarity index 99% rename from spec/yaml/twilio_video.yaml rename to spec/yaml/twilio_video_v1.yaml index 93eee66e..1e2a12e5 100644 --- a/spec/yaml/twilio_video.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -579,7 +579,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Video - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/CompositionHooks: diff --git a/spec/yaml/twilio_voice.yaml b/spec/yaml/twilio_voice_v1.yaml similarity index 99% rename from spec/yaml/twilio_voice.yaml rename to spec/yaml/twilio_voice_v1.yaml index a7b5a2ba..c165e10b 100644 --- a/spec/yaml/twilio_voice.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -295,7 +295,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Voice - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/ByocTrunks: diff --git a/spec/yaml/twilio_wireless.yaml b/spec/yaml/twilio_wireless_v1.yaml similarity index 99% rename from spec/yaml/twilio_wireless.yaml rename to spec/yaml/twilio_wireless_v1.yaml index 0c2721f9..e40ade82 100644 --- a/spec/yaml/twilio_wireless.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -330,7 +330,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Wireless - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Commands: From 9790ea30e4a91497bf8a74e5ff22cf4422773261 Mon Sep 17 00:00:00 2001 From: shwetharadhakrishna Date: Wed, 25 Nov 2020 12:08:57 -0700 Subject: [PATCH 2/7] Updated version --- spec/json/twilio_accounts_v1.json | 2 +- spec/json/twilio_api_v2010.json | 2 +- spec/json/twilio_autopilot_v1.json | 2 +- spec/json/twilio_bulkexports_v1.json | 2 +- spec/json/twilio_chat_v1.json | 2 +- spec/json/twilio_chat_v2.json | 2 +- spec/json/twilio_conversations_v1.json | 2 +- spec/json/twilio_events_v1.json | 2 +- spec/json/twilio_fax_v1.json | 2 +- spec/json/twilio_flex_v1.json | 2 +- spec/json/twilio_insights_v1.json | 2 +- spec/json/twilio_ip_messaging_v1.json | 2 +- spec/json/twilio_ip_messaging_v2.json | 2 +- spec/json/twilio_lookups_v1.json | 2 +- spec/json/twilio_messaging_v1.json | 2 +- spec/json/twilio_monitor_v1.json | 2 +- spec/json/twilio_notify_v1.json | 2 +- spec/json/twilio_numbers_v2.json | 2 +- spec/json/twilio_preview_bulk_exports.json | 2 +- spec/json/twilio_preview_deployed_devices.json | 2 +- spec/json/twilio_preview_hosted_numbers.json | 2 +- spec/json/twilio_preview_marketplace.json | 2 +- spec/json/twilio_preview_sync.json | 2 +- spec/json/twilio_preview_trusted_comms.json | 2 +- spec/json/twilio_preview_understand.json | 2 +- spec/json/twilio_preview_wireless.json | 2 +- spec/json/twilio_pricing_v1.json | 2 +- spec/json/twilio_pricing_v2.json | 2 +- spec/json/twilio_proxy_v1.json | 2 +- spec/json/twilio_serverless_v1.json | 2 +- spec/json/twilio_studio_v1.json | 2 +- 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 | 2 +- spec/json/twilio_trunking_v1.json | 2 +- spec/json/twilio_verify_v2.json | 2 +- spec/json/twilio_video_v1.json | 2 +- spec/json/twilio_voice_v1.json | 2 +- spec/json/twilio_wireless_v1.json | 2 +- spec/yaml/twilio_accounts_v1.yaml | 2 +- spec/yaml/twilio_api_v2010.yaml | 2 +- spec/yaml/twilio_autopilot_v1.yaml | 2 +- spec/yaml/twilio_bulkexports_v1.yaml | 2 +- spec/yaml/twilio_chat_v1.yaml | 2 +- spec/yaml/twilio_chat_v2.yaml | 2 +- spec/yaml/twilio_conversations_v1.yaml | 2 +- spec/yaml/twilio_events_v1.yaml | 2 +- spec/yaml/twilio_fax_v1.yaml | 2 +- spec/yaml/twilio_flex_v1.yaml | 2 +- spec/yaml/twilio_insights_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v2.yaml | 2 +- spec/yaml/twilio_lookups_v1.yaml | 2 +- spec/yaml/twilio_messaging_v1.yaml | 2 +- spec/yaml/twilio_monitor_v1.yaml | 2 +- spec/yaml/twilio_notify_v1.yaml | 2 +- spec/yaml/twilio_numbers_v2.yaml | 2 +- spec/yaml/twilio_preview_bulk_exports.yaml | 2 +- spec/yaml/twilio_preview_deployed_devices.yaml | 2 +- spec/yaml/twilio_preview_hosted_numbers.yaml | 2 +- spec/yaml/twilio_preview_marketplace.yaml | 2 +- spec/yaml/twilio_preview_sync.yaml | 2 +- spec/yaml/twilio_preview_trusted_comms.yaml | 2 +- spec/yaml/twilio_preview_understand.yaml | 2 +- spec/yaml/twilio_preview_wireless.yaml | 2 +- spec/yaml/twilio_pricing_v1.yaml | 2 +- spec/yaml/twilio_pricing_v2.yaml | 2 +- spec/yaml/twilio_proxy_v1.yaml | 2 +- spec/yaml/twilio_serverless_v1.yaml | 2 +- spec/yaml/twilio_studio_v1.yaml | 2 +- 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 | 2 +- spec/yaml/twilio_trunking_v1.yaml | 2 +- spec/yaml/twilio_verify_v2.yaml | 2 +- spec/yaml/twilio_video_v1.yaml | 2 +- spec/yaml/twilio_voice_v1.yaml | 2 +- spec/yaml/twilio_wireless_v1.yaml | 2 +- 80 files changed, 80 insertions(+), 80 deletions(-) diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 660d99cc..f43d12f8 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -142,7 +142,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Accounts", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 4e1f5e74..34ca449f 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -7227,7 +7227,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Api", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json index 25acdd25..78cff008 100644 --- a/spec/json/twilio_autopilot_v1.json +++ b/spec/json/twilio_autopilot_v1.json @@ -690,7 +690,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Autopilot", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index 4b7d38bc..361aaf61 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -162,7 +162,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Bulkexports", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index 09bd3f7c..50f36a52 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -551,7 +551,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Chat", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index 3c5c0493..b48df12a 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -764,7 +764,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Chat", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index f7431d3a..97ded778 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -1111,7 +1111,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Conversations", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index d15bdc7c..be39955a 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -227,7 +227,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Events", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_fax_v1.json b/spec/json/twilio_fax_v1.json index 52fba4e2..17f1ee15 100644 --- a/spec/json/twilio_fax_v1.json +++ b/spec/json/twilio_fax_v1.json @@ -154,7 +154,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Fax", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 4ff6f88b..159b9353 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -343,7 +343,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Flex", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index d9dc0b91..b73f2510 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -518,7 +518,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Insights", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index 70e9fbef..ca8f3ae8 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -551,7 +551,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Ip_messaging", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index e5919c27..dda02371 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -764,7 +764,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Ip_messaging", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index bf64fc4e..88ec1a8d 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -49,7 +49,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Lookups", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index d0219f7c..06c30409 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -279,7 +279,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Messaging", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index 797fba1b..83d1830a 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -257,7 +257,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Monitor", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 09baff7f..65d7496b 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -304,7 +304,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Notify", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index c3908ecf..c6be4c34 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -358,7 +358,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Numbers", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_bulk_exports.json b/spec/json/twilio_preview_bulk_exports.json index b82aa004..0e1229d0 100644 --- a/spec/json/twilio_preview_bulk_exports.json +++ b/spec/json/twilio_preview_bulk_exports.json @@ -162,7 +162,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_deployed_devices.json b/spec/json/twilio_preview_deployed_devices.json index 6d1e1120..da9cdae5 100644 --- a/spec/json/twilio_preview_deployed_devices.json +++ b/spec/json/twilio_preview_deployed_devices.json @@ -249,7 +249,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_hosted_numbers.json b/spec/json/twilio_preview_hosted_numbers.json index c9085a2f..3b340a6c 100644 --- a/spec/json/twilio_preview_hosted_numbers.json +++ b/spec/json/twilio_preview_hosted_numbers.json @@ -301,7 +301,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_marketplace.json b/spec/json/twilio_preview_marketplace.json index 3b760d20..6fba3d68 100644 --- a/spec/json/twilio_preview_marketplace.json +++ b/spec/json/twilio_preview_marketplace.json @@ -159,7 +159,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_sync.json b/spec/json/twilio_preview_sync.json index 53dcf331..cd0f2644 100644 --- a/spec/json/twilio_preview_sync.json +++ b/spec/json/twilio_preview_sync.json @@ -422,7 +422,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_trusted_comms.json b/spec/json/twilio_preview_trusted_comms.json index 222e3f07..7c2e18ee 100644 --- a/spec/json/twilio_preview_trusted_comms.json +++ b/spec/json/twilio_preview_trusted_comms.json @@ -422,7 +422,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_understand.json b/spec/json/twilio_preview_understand.json index 5f0437b2..5ee92220 100644 --- a/spec/json/twilio_preview_understand.json +++ b/spec/json/twilio_preview_understand.json @@ -601,7 +601,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview_wireless.json b/spec/json/twilio_preview_wireless.json index 380c1749..b6775dc9 100644 --- a/spec/json/twilio_preview_wireless.json +++ b/spec/json/twilio_preview_wireless.json @@ -317,7 +317,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Preview", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index 180048a9..d182c612 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -320,7 +320,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index e30ad1f6..ff7abe66 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -174,7 +174,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 41a9e95e..068fefa5 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -628,7 +628,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Proxy", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 6495ac9d..f3385b73 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -601,7 +601,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Serverless", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index d0886428..4eb30e00 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -425,7 +425,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Studio", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index 7911cffe..d78744c4 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -351,7 +351,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Studio", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 27de475f..302a8059 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -341,7 +341,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Supersim", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 784f0140..0da7a034 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -516,7 +516,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Sync", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index 24eb7da1..ae901e8d 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -1401,7 +1401,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Taskrouter", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index 9edf8b4a..d78486a5 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -448,7 +448,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Trunking", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 5561ff30..1f492d3f 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -616,7 +616,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Verify", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 22ac2118..309afb69 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -774,7 +774,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Video", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 887398e8..0c9e54a7 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -398,7 +398,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Voice", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index cee2c01e..40f556c8 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -438,7 +438,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Wireless", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 2a710173..3a73edba 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -104,7 +104,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Accounts - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 612d259c..398aed30 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -6064,7 +6064,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Api - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml index 81b36a09..01e80b3d 100644 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -520,7 +520,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Autopilot - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Assistants: diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 07652f12..99215a4b 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -110,7 +110,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Bulkexports - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Exports/Jobs/{JobSid}: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index a378da19..25512aee 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -412,7 +412,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index 1fb2df88..580fa909 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -572,7 +572,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Credentials: diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 19f704ea..e0364752 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -837,7 +837,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Conversations - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Configuration: diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 00ffe8c3..b75238ea 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -161,7 +161,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Events - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Schemas/{Id}: diff --git a/spec/yaml/twilio_fax_v1.yaml b/spec/yaml/twilio_fax_v1.yaml index 561647bb..447e6fc6 100644 --- a/spec/yaml/twilio_fax_v1.yaml +++ b/spec/yaml/twilio_fax_v1.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Fax - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Faxes: diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 530506e7..602e3a5e 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -256,7 +256,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Flex - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Channels: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 889e8cf9..aec94222 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -390,7 +390,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Insights - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Video/Rooms: diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 045fe450..4f7565d2 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -412,7 +412,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Ip_messaging - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index 9e4cda1f..c589ba4d 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -572,7 +572,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Ip_messaging - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Credentials: diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 0817ede5..268f7759 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -33,7 +33,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Lookups - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index f42cbc31..8582f85d 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -209,7 +209,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Messaging - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Deactivations: diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index 3184ace7..c1f10d2b 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -194,7 +194,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Monitor - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Alerts: diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 29d4d99b..8307ed43 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -221,7 +221,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Notify - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index be40fc51..49e79265 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -265,7 +265,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Numbers - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/RegulatoryCompliance/Bundles: diff --git a/spec/yaml/twilio_preview_bulk_exports.yaml b/spec/yaml/twilio_preview_bulk_exports.yaml index 095ec0d4..5b81a87c 100644 --- a/spec/yaml/twilio_preview_bulk_exports.yaml +++ b/spec/yaml/twilio_preview_bulk_exports.yaml @@ -110,7 +110,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /BulkExports/Exports/Jobs/{JobSid}: diff --git a/spec/yaml/twilio_preview_deployed_devices.yaml b/spec/yaml/twilio_preview_deployed_devices.yaml index 52346463..a030a3ad 100644 --- a/spec/yaml/twilio_preview_deployed_devices.yaml +++ b/spec/yaml/twilio_preview_deployed_devices.yaml @@ -185,7 +185,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /DeployedDevices/Fleets: diff --git a/spec/yaml/twilio_preview_hosted_numbers.yaml b/spec/yaml/twilio_preview_hosted_numbers.yaml index 93f0635c..befdddbc 100644 --- a/spec/yaml/twilio_preview_hosted_numbers.yaml +++ b/spec/yaml/twilio_preview_hosted_numbers.yaml @@ -224,7 +224,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /HostedNumbers/AuthorizationDocuments: diff --git a/spec/yaml/twilio_preview_marketplace.yaml b/spec/yaml/twilio_preview_marketplace.yaml index 9d3700f7..72411bff 100644 --- a/spec/yaml/twilio_preview_marketplace.yaml +++ b/spec/yaml/twilio_preview_marketplace.yaml @@ -114,7 +114,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /marketplace/AvailableAddOns: diff --git a/spec/yaml/twilio_preview_sync.yaml b/spec/yaml/twilio_preview_sync.yaml index 1adcf73a..328775cf 100644 --- a/spec/yaml/twilio_preview_sync.yaml +++ b/spec/yaml/twilio_preview_sync.yaml @@ -312,7 +312,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /Sync/Services: diff --git a/spec/yaml/twilio_preview_trusted_comms.yaml b/spec/yaml/twilio_preview_trusted_comms.yaml index b494c026..fdb0ee6c 100644 --- a/spec/yaml/twilio_preview_trusted_comms.yaml +++ b/spec/yaml/twilio_preview_trusted_comms.yaml @@ -314,7 +314,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels: diff --git a/spec/yaml/twilio_preview_understand.yaml b/spec/yaml/twilio_preview_understand.yaml index e4e75756..4b7905f1 100644 --- a/spec/yaml/twilio_preview_understand.yaml +++ b/spec/yaml/twilio_preview_understand.yaml @@ -454,7 +454,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /understand/Assistants: diff --git a/spec/yaml/twilio_preview_wireless.yaml b/spec/yaml/twilio_preview_wireless.yaml index 1fa64779..b7275d12 100644 --- a/spec/yaml/twilio_preview_wireless.yaml +++ b/spec/yaml/twilio_preview_wireless.yaml @@ -241,7 +241,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Preview - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /wireless/Commands: diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index 10005619..088a8d8e 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -211,7 +211,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Messaging/Countries: diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index d0ffa8b8..e33f4289 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Voice/Countries: diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index e3fb7c09..e5c78019 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -493,7 +493,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Proxy - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index 3e14bc39..e8d1f250 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -457,7 +457,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Serverless - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index f108cf54..6c7338e1 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -320,7 +320,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Flows: diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index afe19eb1..4db8b7a4 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -257,7 +257,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Flows: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index c87dc621..0587b7da 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -255,7 +255,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Supersim - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Commands: diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index a4d184c4..a477a1bb 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -381,7 +381,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Sync - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 9f5bbe81..1bdacb55 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1041,7 +1041,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Taskrouter - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Workspaces: diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index ce131e5f..cf9567db 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -347,7 +347,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Trunking - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Trunks: diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 6806b83e..af4622bc 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -455,7 +455,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Verify - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Forms/{FormType}: diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 1e2a12e5..93eee66e 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -579,7 +579,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Video - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/CompositionHooks: diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index c165e10b..a7b5a2ba 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -295,7 +295,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Voice - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/ByocTrunks: diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index e40ade82..0c2721f9 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -330,7 +330,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Wireless - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Commands: From 695fafe7526abd7c8c30113fa4f100e480973238 Mon Sep 17 00:00:00 2001 From: shwetharadhakrishna Date: Mon, 30 Nov 2020 13:54:52 -0700 Subject: [PATCH 3/7] Ignoring preview --- spec/.DS_Store | Bin 0 -> 6148 bytes spec/json/twilio_accounts_v1.json | 2 +- spec/json/twilio_api_v2010.json | 5 +- spec/json/twilio_autopilot_v1.json | 2 +- spec/json/twilio_bulkexports_v1.json | 2 +- spec/json/twilio_chat_v1.json | 2 +- spec/json/twilio_chat_v2.json | 2 +- spec/json/twilio_conversations_v1.json | 2 +- spec/json/twilio_events_v1.json | 2 +- spec/json/twilio_fax_v1.json | 2 +- spec/json/twilio_flex_v1.json | 2 +- spec/json/twilio_insights_v1.json | 2 +- spec/json/twilio_ip_messaging_v1.json | 2 +- spec/json/twilio_ip_messaging_v2.json | 2 +- spec/json/twilio_lookups_v1.json | 2 +- spec/json/twilio_messaging_v1.json | 2 +- spec/json/twilio_monitor_v1.json | 2 +- spec/json/twilio_notify_v1.json | 2 +- spec/json/twilio_numbers_v2.json | 2 +- spec/json/twilio_preview_bulk_exports.json | 710 ---- .../json/twilio_preview_deployed_devices.json | 1806 --------- spec/json/twilio_preview_hosted_numbers.json | 1276 ------ spec/json/twilio_preview_marketplace.json | 951 ----- spec/json/twilio_preview_sync.json | 3231 --------------- spec/json/twilio_preview_trusted_comms.json | 1238 ------ spec/json/twilio_preview_understand.json | 3588 ----------------- spec/json/twilio_preview_wireless.json | 1255 ------ spec/json/twilio_pricing_v1.json | 2 +- spec/json/twilio_pricing_v2.json | 2 +- spec/json/twilio_proxy_v1.json | 2 +- spec/json/twilio_serverless_v1.json | 2 +- spec/json/twilio_studio_v1.json | 2 +- 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 | 2 +- spec/json/twilio_trunking_v1.json | 36 +- spec/json/twilio_verify_v2.json | 2 +- spec/json/twilio_video_v1.json | 2 +- spec/json/twilio_voice_v1.json | 2 +- spec/json/twilio_wireless_v1.json | 2 +- spec/yaml/twilio_accounts_v1.yaml | 2 +- spec/yaml/twilio_api_v2010.yaml | 4 +- spec/yaml/twilio_autopilot_v1.yaml | 2 +- spec/yaml/twilio_bulkexports_v1.yaml | 2 +- spec/yaml/twilio_chat_v1.yaml | 2 +- spec/yaml/twilio_chat_v2.yaml | 2 +- spec/yaml/twilio_conversations_v1.yaml | 2 +- spec/yaml/twilio_events_v1.yaml | 2 +- spec/yaml/twilio_fax_v1.yaml | 2 +- spec/yaml/twilio_flex_v1.yaml | 2 +- spec/yaml/twilio_insights_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v2.yaml | 2 +- spec/yaml/twilio_lookups_v1.yaml | 2 +- spec/yaml/twilio_messaging_v1.yaml | 2 +- spec/yaml/twilio_monitor_v1.yaml | 2 +- spec/yaml/twilio_notify_v1.yaml | 2 +- spec/yaml/twilio_numbers_v2.yaml | 2 +- spec/yaml/twilio_preview_bulk_exports.yaml | 468 --- .../yaml/twilio_preview_deployed_devices.yaml | 1242 ------ spec/yaml/twilio_preview_hosted_numbers.yaml | 973 ----- spec/yaml/twilio_preview_marketplace.yaml | 636 --- spec/yaml/twilio_preview_sync.yaml | 2139 ---------- spec/yaml/twilio_preview_trusted_comms.yaml | 926 ----- spec/yaml/twilio_preview_understand.yaml | 2389 ----------- spec/yaml/twilio_preview_wireless.yaml | 862 ---- spec/yaml/twilio_pricing_v1.yaml | 2 +- spec/yaml/twilio_pricing_v2.yaml | 2 +- spec/yaml/twilio_proxy_v1.yaml | 2 +- spec/yaml/twilio_serverless_v1.yaml | 2 +- spec/yaml/twilio_studio_v1.yaml | 2 +- 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 | 2 +- spec/yaml/twilio_trunking_v1.yaml | 32 +- spec/yaml/twilio_verify_v2.yaml | 2 +- spec/yaml/twilio_video_v1.yaml | 2 +- spec/yaml/twilio_voice_v1.yaml | 2 +- spec/yaml/twilio_wireless_v1.yaml | 2 +- 81 files changed, 111 insertions(+), 23776 deletions(-) create mode 100644 spec/.DS_Store delete mode 100644 spec/json/twilio_preview_bulk_exports.json delete mode 100644 spec/json/twilio_preview_deployed_devices.json delete mode 100644 spec/json/twilio_preview_hosted_numbers.json delete mode 100644 spec/json/twilio_preview_marketplace.json delete mode 100644 spec/json/twilio_preview_sync.json delete mode 100644 spec/json/twilio_preview_trusted_comms.json delete mode 100644 spec/json/twilio_preview_understand.json delete mode 100644 spec/json/twilio_preview_wireless.json delete mode 100644 spec/yaml/twilio_preview_bulk_exports.yaml delete mode 100644 spec/yaml/twilio_preview_deployed_devices.yaml delete mode 100644 spec/yaml/twilio_preview_hosted_numbers.yaml delete mode 100644 spec/yaml/twilio_preview_marketplace.yaml delete mode 100644 spec/yaml/twilio_preview_sync.yaml delete mode 100644 spec/yaml/twilio_preview_trusted_comms.yaml delete mode 100644 spec/yaml/twilio_preview_understand.yaml delete mode 100644 spec/yaml/twilio_preview_wireless.yaml diff --git a/spec/.DS_Store b/spec/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..297d2a8e589769a1660daf6dc57cdba0928243b9 GIT binary patch literal 6148 zcmeHKPfrs;6n_Inwnb$5Q=!pAV`D-B2T&p!L#PF#4KY+oumrH|wo6&r&NRDQYN<8- z3SKqd_2j{$U%>bUJQ+WNUOnlXKP~_C;=vfQFPZthdGp?zzTfWbbO3;)s>Nvl9RM_J z977T8ej|LIw^P!kEIo*X=SVxOU^>jiF;5ssz(Byj|IGm3yCHZ29x$LM_U~<+8~-Up z6w&cBYhFd|^G{~Qu|0ok>NDx;4)vVt)wGBf>5pt>cUdj#8-CSG8SVxjWek7URQf7o zPDeM)HQTD?^^pZeeZ!`fD}wE!g)WVig}BnpW!-^cguch;;W{%c3IR^3IND`MJD4;1yivI2q>I zzRl?Rk=gZ44|z}fRyj>~7_PXFJTF(co401U9^$F^+`8eq1}#~s`j%suma|M#%=cND zd-7}rMl-I(Gv#d5c`b?g?~=tta;dG1OGSr-RPYSZ$tq>k3WpQPj52C40e9d5tic`} zzzcW{@8AP`gfH+7evn=gBUi`-nIUszp4=yCvP3fEAz6{pUF}DCxxIu$vVqunl>1qi zI*gXk#{EN32LsCBoOs#a0(8GQ^0LcRXS!GPX?NO>RQ@fAG8~9l8S|)> ziMpW>b@3o^;SMAzG3WyZ0tSvV&@G2LKmYII9{$7q|9DU^3K$3&I8zLe&|-Emg(a!8 z^;B{Etc_#a#>R#FwIqrV?9_2A6n+$sVH1LLajqaH6}BXz1ts_+AZQ4>fPsI?z%MA! B+1500456`, and right after doing `+1500456`", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallSid": { - "description": "The Call sid this Branded Call should link to.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "From": { - "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", - "type": "string" - }, - "Reason": { - "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", - "type": "string" - }, - "To": { - "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "type": "string" - } - }, - "required": [ - "From", - "To", - "Reason" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.branded_call" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "bg_color", - "brand_sid", - "branded_channel_sid", - "business_sid", - "call_sid", - "caller", - "created_at", - "font_color", - "from", - "logo", - "phone_number_sid", - "reason", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "list" - }, - "/TrustedComms/Business/PhoneCalls": { - "description": "TODO: Resource-level docs", - "post": { - "description": "Initiates a Branded Call.", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApplicationSid": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "CallerId": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "FallbackMethod": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "FallbackUrl": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "format": "uri", - "type": "string" - }, - "From": { - "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", - "type": "string" - }, - "MachineDetection": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "MachineDetectionSilenceTimeout": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "MachineDetectionSpeechEndThreshold": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "MachineDetectionSpeechThreshold": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "MachineDetectionTimeout": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "Method": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Reason": { - "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", - "type": "string" - }, - "Record": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "boolean" - }, - "RecordingChannels": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "RecordingStatusCallback": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "RecordingStatusCallbackEvent": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "items": { - "type": "string" - }, - "type": "array" - }, - "RecordingStatusCallbackMethod": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SendDigits": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "SipAuthPassword": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "SipAuthUsername": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "StatusCallback": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "format": "uri", - "type": "string" - }, - "StatusCallbackEvent": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "items": { - "type": "string" - }, - "type": "array" - }, - "StatusCallbackMethod": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Timeout": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "integer" - }, - "To": { - "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "type": "string" - }, - "Trim": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "type": "string" - }, - "Url": { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "format": "uri", - "type": "string" - } - }, - "required": [ - "From", - "To" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.phone_call" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "bg_color", - "brand_sid", - "branded_channel_sid", - "business_sid", - "call_sid", - "caller", - "created_at", - "font_color", - "from", - "logo", - "phone_number_sid", - "reason", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "list" - }, - "/TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Impressions Rate.", - "parameters": [ - { - "description": "The unique SID identifier of the Business to filter by.", - "in": "path", - "name": "BusinessSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Brand to filter by.", - "in": "query", - "name": "BrandSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BZ[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Branded Channel to filter by.", - "in": "query", - "name": "BrandedChannelSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Phone Number to filter by.", - "in": "query", - "name": "PhoneNumberSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The 2-letter ISO 3166 code of the Country to filter by.", - "in": "query", - "name": "Country", - "schema": { - "type": "string" - } - }, - { - "description": "The start date that for this Impressions Rate, given in ISO 8601 format. Default value is 30 days ago.", - "in": "query", - "name": "Start", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The end date that for this Impressions Rate, given in ISO 8601 format. Default value is current timestamp.", - "in": "query", - "name": "End", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The Interval of this Impressions Rate. One of `minute`, `hour`, `day`, `week` or `month`.", - "in": "query", - "name": "Interval", - "schema": { - "enum": [ - "minute", - "hour", - "day", - "week", - "month" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "start", - "end", - "interval", - "business_sid", - "reports", - "url" - ], - "x-path-type": "instance" - }, - "/TrustedComms/Businesses/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Business.", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this Business.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.business" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "sid", - "url", - "links" - ], - "x-path-type": "instance" - }, - "/TrustedComms/CPS": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Call Placement Service (CPS) given a phone number via `X-XCNAM-Sensitive-Phone-Number` header.", - "parameters": [ - { - "description": "The X-Xcnam-Sensitive-Phone-Number HTTP request header", - "in": "header", - "name": "X-Xcnam-Sensitive-Phone-Number", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.cps" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "cps_url", - "phone_number", - "url" - ], - "x-path-type": "instance" - }, - "/TrustedComms/CurrentCall": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a current call given the originating and terminating number via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` headers.", - "parameters": [ - { - "description": "The X-Xcnam-Sensitive-Phone-Number-From HTTP request header", - "in": "header", - "name": "X-Xcnam-Sensitive-Phone-Number-From", - "schema": { - "type": "string" - } - }, - { - "description": "The X-Xcnam-Sensitive-Phone-Number-To HTTP request header", - "in": "header", - "name": "X-Xcnam-Sensitive-Phone-Number-To", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.current_call" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "bg_color", - "caller", - "created_at", - "font_color", - "from", - "logo", - "manager", - "reason", - "shield_img", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "instance" - } - }, - "tags": [ - { - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", - "name": "Preview" - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_preview_understand.json b/spec/json/twilio_preview_understand.json deleted file mode 100644 index 5ee92220..00000000 --- a/spec/json/twilio_preview_understand.json +++ /dev/null @@ -1,3588 +0,0 @@ -{ - "components": { - "schemas": { - "preview.understand.assistant": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "callback_events": { - "type": "string" - }, - "callback_url": { - "format": "uri", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "latest_model_build_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "type": "string" - }, - "links": { - "type": "object" - }, - "log_queries": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.assistant_fallback_actions": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.assistant_initiation_actions": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.dialogue": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.field_type": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.field_type.field_value": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "field_type_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "type": "string" - }, - "language": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "type": "string" - }, - "synonym_of": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "value": { - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.model_build": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "build_duration": { - "nullable": true, - "type": "integer" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "error_code": { - "nullable": true, - "type": "integer" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "enum": [ - "enqueued", - "building", - "completed", - "failed", - "canceled" - ], - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.query": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "language": { - "type": "string" - }, - "model_build_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "type": "string" - }, - "query": { - "type": "string" - }, - "results": { - "type": "object" - }, - "sample_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UH[0-9a-fA-F]{32}$", - "type": "string" - }, - "source_channel": { - "type": "string" - }, - "status": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.style_sheet": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "actions_url": { - "format": "uri", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "links": { - "type": "object" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.field": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "field_type": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UE[0-9a-fA-F]{32}$", - "type": "string" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.sample": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "language": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - }, - "source_channel": { - "type": "string" - }, - "tagged_text": { - "type": "string" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.task_actions": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "data": { - "type": "object" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.understand.assistant.task.task_statistics": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assistant_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "type": "string" - }, - "fields_count": { - "type": "integer" - }, - "samples_count": { - "type": "integer" - }, - "task_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - } - }, - "info": { - "contact": { - "email": "support@twilio.com", - "name": "Twilio Support", - "url": "https://support.twilio.com" - }, - "description": "This is the public Twilio REST API.", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Preview", - "version": "1.3.0" - }, - "openapi": "3.0.1", - "paths": { - "/understand/Assistants": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "assistants": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackEvents": { - "description": "Space-separated list of callback events that will trigger callbacks.", - "type": "string" - }, - "CallbackUrl": { - "description": "A user-provided URL to send event callbacks to.", - "format": "uri", - "type": "string" - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", - "type": "object" - }, - "FriendlyName": { - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", - "type": "object" - }, - "LogQueries": { - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", - "type": "boolean" - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant", - "type": "object" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.dialogue" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/FallbackActions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FallbackActions": { - "description": "", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "field_types": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "UniqueName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An ISO language-country string of the value. For example: *en-US*", - "in": "query", - "name": "Language", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "field_values": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Language": { - "description": "An ISO language-country string of the value.", - "type": "string" - }, - "SynonymOf": { - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.", - "type": "string" - }, - "Value": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "Language", - "Value" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "FieldTypeSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/InitiationActions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "InitiationActions": { - "description": "", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "model_builds": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "StatusCallback": { - "description": "", - "format": "uri", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Queries": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "schema": { - "type": "string" - } - }, - { - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "in": "query", - "name": "ModelBuild", - "schema": { - "type": "string" - } - }, - { - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", - "in": "query", - "name": "Status", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "queries": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Field": { - "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*", - "type": "string" - }, - "Language": { - "description": "An ISO language-country string of the sample.", - "type": "string" - }, - "ModelBuild": { - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "type": "string" - }, - "Query": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.", - "type": "string" - }, - "Tasks": { - "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*", - "type": "string" - } - }, - "required": [ - "Language", - "Query" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "SampleSid": { - "description": "An optional reference to the Sample created from this query.", - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - }, - "Status": { - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/StyleSheet": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Returns Style sheet JSON object for this Assistant", - "parameters": [ - { - "description": "The unique ID of the Assistant", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", - "parameters": [ - { - "description": "The unique ID of the Assistant", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "StyleSheet": { - "description": "The JSON Style sheet string", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "tasks": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", - "type": "object" - }, - "ActionsUrl": { - "description": "User-provided HTTP endpoint where from the assistant fetches actions", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "UniqueName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", - "type": "object" - }, - "ActionsUrl": { - "description": "User-provided HTTP endpoint where from the assistant fetches actions", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Returns JSON actions for this Task.", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Actions": { - "description": "The JSON actions that instruct the Assistant how to perform this task.", - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "fields": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FieldType": { - "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.", - "type": "string" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FieldType", - "UniqueName" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "samples": { - "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Language": { - "description": "An ISO language-country string of the sample.", - "type": "string" - }, - "SourceChannel": { - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", - "type": "string" - }, - "TaggedText": { - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", - "type": "string" - } - }, - "required": [ - "Language", - "TaggedText" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Sample.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Language": { - "description": "An ISO language-country string of the sample.", - "type": "string" - }, - "SourceChannel": { - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", - "type": "string" - }, - "TaggedText": { - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The unique ID of the parent Assistant.", - "in": "path", - "name": "AssistantSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique ID of the Task associated with this Field.", - "in": "path", - "name": "TaskSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/understand/Assistants/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackEvents": { - "description": "Space-separated list of callback events that will trigger callbacks.", - "type": "string" - }, - "CallbackUrl": { - "description": "A user-provided URL to send event callbacks to.", - "format": "uri", - "type": "string" - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", - "type": "object" - }, - "FriendlyName": { - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", - "type": "string" - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", - "type": "object" - }, - "LogQueries": { - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", - "type": "boolean" - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant", - "type": "object" - }, - "UniqueName": { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - } - }, - "tags": [ - { - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", - "name": "Preview" - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_preview_wireless.json b/spec/json/twilio_preview_wireless.json deleted file mode 100644 index b6775dc9..00000000 --- a/spec/json/twilio_preview_wireless.json +++ /dev/null @@ -1,1255 +0,0 @@ -{ - "components": { - "schemas": { - "preview.wireless.command": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "command": { - "type": "string" - }, - "command_mode": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "device_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "direction": { - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", - "type": "string" - }, - "sim_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.wireless.rate_plan": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "data_enabled": { - "type": "boolean" - }, - "data_limit": { - "type": "integer" - }, - "data_metering": { - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "international_roaming": { - "items": { - "type": "string" - }, - "type": "array" - }, - "messaging_enabled": { - "type": "boolean" - }, - "national_roaming_enabled": { - "type": "boolean" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "voice_enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "preview.wireless.sim": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "commands_callback_method": { - "type": "string" - }, - "commands_callback_url": { - "format": "uri", - "type": "string" - }, - "date_created": { - "format": "date-time", - "type": "string" - }, - "date_updated": { - "format": "date-time", - "type": "string" - }, - "e_id": { - "type": "string" - }, - "friendly_name": { - "type": "string" - }, - "iccid": { - "type": "string" - }, - "links": { - "type": "object" - }, - "rate_plan_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "sms_fallback_url": { - "format": "uri", - "type": "string" - }, - "sms_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "sms_url": { - "format": "uri", - "type": "string" - }, - "status": { - "type": "string" - }, - "unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - }, - "voice_fallback_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "voice_fallback_url": { - "format": "uri", - "type": "string" - }, - "voice_method": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "voice_url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "preview.wireless.sim.usage": { - "properties": { - "account_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "commands_costs": { - "type": "object" - }, - "commands_usage": { - "type": "object" - }, - "data_costs": { - "type": "object" - }, - "data_usage": { - "type": "object" - }, - "period": { - "type": "object" - }, - "sim_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sim_unique_name": { - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - } - }, - "info": { - "contact": { - "email": "support@twilio.com", - "name": "Twilio Support", - "url": "https://support.twilio.com" - }, - "description": "This is the public Twilio REST API.", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Preview", - "version": "1.3.0" - }, - "openapi": "3.0.1", - "paths": { - "/wireless/Commands": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "Device", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Sim", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Status", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Direction", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "commands": { - "items": { - "$ref": "#/components/schemas/preview.wireless.command" - }, - "type": "array" - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackMethod": { - "description": "", - "type": "string" - }, - "CallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "Command": { - "description": "", - "type": "string" - }, - "CommandMode": { - "description": "", - "type": "string" - }, - "Device": { - "description": "", - "type": "string" - }, - "IncludeSid": { - "description": "", - "type": "string" - }, - "Sim": { - "description": "", - "type": "string" - } - }, - "required": [ - "Command" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.command" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/wireless/Commands/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.command" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/RatePlans": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "rate_plans": { - "items": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CommandsEnabled": { - "description": "", - "type": "boolean" - }, - "DataEnabled": { - "description": "", - "type": "boolean" - }, - "DataLimit": { - "description": "", - "type": "integer" - }, - "DataMetering": { - "description": "", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "InternationalRoaming": { - "description": "", - "items": { - "type": "string" - }, - "type": "array" - }, - "MessagingEnabled": { - "description": "", - "type": "boolean" - }, - "NationalRoamingEnabled": { - "description": "", - "type": "boolean" - }, - "UniqueName": { - "description": "", - "type": "string" - }, - "VoiceEnabled": { - "description": "", - "type": "boolean" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/wireless/RatePlans/{Sid}": { - "delete": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "", - "type": "string" - }, - "UniqueName": { - "description": "", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/Sims": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "Status", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Iccid", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "RatePlan", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "EId", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "SimRegistrationCode", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "sims": { - "items": { - "$ref": "#/components/schemas/preview.wireless.sim" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "list" - }, - "/wireless/Sims/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackMethod": { - "description": "", - "type": "string" - }, - "CallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "CommandsCallbackMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "CommandsCallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "", - "type": "string" - }, - "RatePlan": { - "description": "", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "Status": { - "description": "", - "type": "string" - }, - "UniqueName": { - "description": "", - "type": "string" - }, - "VoiceFallbackMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "", - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/wireless/Sims/{SimSid}/Usage": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "", - "in": "path", - "name": "SimSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "End", - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Start", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim.usage" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - } - }, - "tags": [ - { - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", - "name": "Preview" - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index d182c612..180048a9 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -320,7 +320,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index ff7abe66..e30ad1f6 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -174,7 +174,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 068fefa5..41a9e95e 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -628,7 +628,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Proxy", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index f3385b73..6495ac9d 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -601,7 +601,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Serverless", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 4eb30e00..d0886428 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -425,7 +425,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Studio", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index d78744c4..7911cffe 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -351,7 +351,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Studio", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 302a8059..27de475f 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -341,7 +341,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Supersim", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 0da7a034..784f0140 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -516,7 +516,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Sync", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index ae901e8d..24eb7da1 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -1401,7 +1401,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Taskrouter", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index d78486a5..8ff59a98 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -413,16 +413,6 @@ "do-not-trim" ], "type": "string" - }, - "trunk_sid": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" } }, "type": "object" @@ -448,7 +438,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Trunking", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { @@ -1992,7 +1982,7 @@ "description": "", "parameters": [ { - "description": "", + "description": "The SID of the Trunk that will have its recording settings updated.", "in": "path", "name": "TrunkSid", "required": true, @@ -2008,7 +1998,27 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": {}, + "properties": { + "Mode": { + "description": "The recording mode for the trunk. Can be do-not-record (default), record-from-ringing, record-from-answer, record-from-ringing-dual, or record-from-answer-dual.", + "enum": [ + "do-not-record", + "record-from-ringing", + "record-from-answer", + "record-from-ringing-dual", + "record-from-answer-dual" + ], + "type": "string" + }, + "Trim": { + "description": "The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence.", + "enum": [ + "trim-silence", + "do-not-trim" + ], + "type": "string" + } + }, "type": "object" } } diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 1f492d3f..5561ff30 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -616,7 +616,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Verify", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 309afb69..22ac2118 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -774,7 +774,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Video", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 0c9e54a7..887398e8 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -398,7 +398,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Voice", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index 40f556c8..cee2c01e 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -438,7 +438,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Wireless", - "version": "1.3.0" + "version": "5.12.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 3a73edba..2a710173 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -104,7 +104,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Accounts - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 398aed30..c4a626c7 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -995,6 +995,8 @@ components: - completed - absent type: string + track: + type: string uri: format: uri type: string @@ -6064,7 +6066,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Api - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml index 01e80b3d..81b36a09 100644 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -520,7 +520,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Autopilot - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Assistants: diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 99215a4b..07652f12 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -110,7 +110,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Bulkexports - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Exports/Jobs/{JobSid}: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index 25512aee..a378da19 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -412,7 +412,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index 580fa909..1fb2df88 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -572,7 +572,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/Credentials: diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index e0364752..19f704ea 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -837,7 +837,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Conversations - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Configuration: diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index b75238ea..00ffe8c3 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -161,7 +161,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Events - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Schemas/{Id}: diff --git a/spec/yaml/twilio_fax_v1.yaml b/spec/yaml/twilio_fax_v1.yaml index 447e6fc6..561647bb 100644 --- a/spec/yaml/twilio_fax_v1.yaml +++ b/spec/yaml/twilio_fax_v1.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Fax - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Faxes: diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 602e3a5e..530506e7 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -256,7 +256,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Flex - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Channels: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index aec94222..889e8cf9 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -390,7 +390,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Insights - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Video/Rooms: diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 4f7565d2..045fe450 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -412,7 +412,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Ip_messaging - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index c589ba4d..9e4cda1f 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -572,7 +572,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Ip_messaging - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/Credentials: diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 268f7759..0817ede5 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -33,7 +33,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Lookups - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index 8582f85d..f42cbc31 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -209,7 +209,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Messaging - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Deactivations: diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index c1f10d2b..3184ace7 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -194,7 +194,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Monitor - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Alerts: diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 8307ed43..29d4d99b 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -221,7 +221,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Notify - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index 49e79265..be40fc51 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -265,7 +265,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Numbers - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/RegulatoryCompliance/Bundles: diff --git a/spec/yaml/twilio_preview_bulk_exports.yaml b/spec/yaml/twilio_preview_bulk_exports.yaml deleted file mode 100644 index 5b81a87c..00000000 --- a/spec/yaml/twilio_preview_bulk_exports.yaml +++ /dev/null @@ -1,468 +0,0 @@ -components: - schemas: - preview.bulk_exports.export: - properties: - links: - type: object - resource_type: - type: string - url: - format: uri - type: string - type: object - preview.bulk_exports.export.day: - properties: - create_date: - type: string - day: - type: string - friendly_name: - type: string - resource_type: - type: string - size: - type: integer - type: object - preview.bulk_exports.export.day|instance: - properties: - redirect_to: - format: uri - type: string - type: object - preview.bulk_exports.export.export_custom_job: - properties: - details: - type: object - email: - type: string - end_day: - type: string - friendly_name: - type: string - job_sid: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - resource_type: - type: string - start_day: - type: string - webhook_method: - type: string - webhook_url: - type: string - type: object - preview.bulk_exports.export.job: - properties: - details: - type: object - email: - type: string - end_day: - type: string - friendly_name: - type: string - job_sid: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - resource_type: - type: string - start_day: - type: string - url: - format: uri - type: string - webhook_method: - type: string - webhook_url: - type: string - type: object - preview.bulk_exports.export_configuration: - properties: - enabled: - type: boolean - resource_type: - type: string - url: - format: uri - type: string - webhook_method: - type: string - webhook_url: - format: uri - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /BulkExports/Exports/Jobs/{JobSid}: - delete: - description: '' - parameters: - - description: The unique string that that we created to identify the Bulk Export - job - in: path - name: JobSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: JobSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^JS[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export.job' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /BulkExports/Exports/{ResourceType}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Export. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /BulkExports/Exports/{ResourceType}/Configuration: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Export Configuration. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export_configuration' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update a specific Export Configuration. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Enabled: - description: If true, Twilio will automatically generate every day's - file when the day is over. - type: boolean - WebhookMethod: - description: Sets whether Twilio should call a webhook URL when - the automatic generation is complete, using GET or POST. The actual - destination is set in the webhook_url - type: string - WebhookUrl: - description: Stores the URL destination for the method specified - in webhook_method. - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export_configuration' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /BulkExports/Exports/{ResourceType}/Days: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Days for a resource. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - days: - items: - $ref: '#/components/schemas/preview.bulk_exports.export.day' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /BulkExports/Exports/{ResourceType}/Days/{Day}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Day. - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - - description: The ISO 8601 format date of the resources in the file, for a - UTC day - in: path - name: Day - required: true - schema: - type: string - responses: - 307: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export.day|instance' - description: Temporary Redirect - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /BulkExports/Exports/{ResourceType}/Jobs: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: "The type of communication \u2013 Messages, Calls" - in: path - name: ResourceType - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - jobs: - items: - $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: "The type of communication \u2013 Messages or Calls" - in: path - name: ResourceType - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Email: - description: The optional email to send the completion notification - to - type: string - EndDay: - description: The end day for the custom export specified as a string - in the format of yyyy-mm-dd. End day is inclusive and must be - 2 days earlier than the current UTC day. - type: string - FriendlyName: - description: The friendly name specified when creating the job - type: string - StartDay: - description: The start day for the custom export specified as a - string in the format of yyyy-mm-dd - type: string - WebhookMethod: - description: This is the method used to call the webhook on completion - of the job. If this is supplied, `WebhookUrl` must also be supplied. - type: string - WebhookUrl: - description: The optional webhook url called on completion of the - job. If this is supplied, `WebhookMethod` must also be supplied. - type: string - required: - - StartDay - - EndDay - - FriendlyName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: list -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_deployed_devices.yaml b/spec/yaml/twilio_preview_deployed_devices.yaml deleted file mode 100644 index a030a3ad..00000000 --- a/spec/yaml/twilio_preview_deployed_devices.yaml +++ /dev/null @@ -1,1242 +0,0 @@ -components: - schemas: - preview.deployed_devices.fleet: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - default_deployment_sid: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.certificate: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - device_sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - fleet_sid: - type: string - friendly_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - thumbprint: - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.deployment: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - fleet_sid: - type: string - friendly_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - sync_service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.device: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_authenticated: - format: date-time - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - deployment_sid: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - enabled: - type: boolean - fleet_sid: - type: string - friendly_name: - type: string - identity: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.deployed_devices.fleet.key: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - device_sid: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - fleet_sid: - type: string - friendly_name: - type: string - secret: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /DeployedDevices/Fleets: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Fleets belonging to your account. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - fleets: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create a new Fleet for scoping of deployed devices within your - account. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id005 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Certificates: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Certificate credentials belonging to the - Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Filters the resulting list of Certificates by a unique string - identifier of an authenticated Device. - in: query - name: DeviceSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - certificates: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Enroll a new Certificate credential to the Fleet, optionally giving - it a friendly name and assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CertificateData: - description: Provides a URL encoded representation of the public - certificate in PEM format. - type: string - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - type: string - required: - - CertificateData - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: - delete: - description: Unregister a specific Certificate credential from the Fleet, effectively - disallowing any inbound client connections that are presenting it. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Certificate credential in the - Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Certificate credential - in the Fleet, giving it a friendly name or assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /DeployedDevices/Fleets/{FleetSid}/Deployments: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Deployments belonging to the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - deployments: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create a new Deployment in the Fleet, optionally giving it a friendly - name and linking to a specific Twilio Sync service instance. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: Provides a human readable descriptive text for this - Deployment, up to 256 characters long. - type: string - SyncServiceSid: - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: - delete: - description: Delete a specific Deployment from the Fleet, leaving associated - devices effectively undeployed. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Deployment in the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Deployment credential - in the Fleet, giving it a friendly name or linking to a specific Twilio Sync - service instance. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: Provides a human readable descriptive text for this - Deployment, up to 64 characters long - type: string - SyncServiceSid: - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /DeployedDevices/Fleets/{FleetSid}/Devices: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Devices belonging to the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Filters the resulting list of Devices by a unique string identifier - of the Deployment they are associated with. - in: query - name: DeploymentSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - devices: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - 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. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeploymentSid: - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - Enabled: - description: '' - type: boolean - FriendlyName: - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - type: string - Identity: - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - type: string - UniqueName: - 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. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id003 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: - delete: - description: Delete a specific Device from the Fleet, also removing it from - associated Deployments. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Device in the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Device in the Fleet, - giving it a friendly name, assigning to a Deployment, or a human identity. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeploymentSid: - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - Enabled: - description: '' - type: boolean - FriendlyName: - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - type: string - Identity: - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /DeployedDevices/Fleets/{FleetSid}/Keys: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Keys credentials belonging to the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Filters the resulting list of Keys by a unique string identifier - of an authenticated Device. - in: query - name: DeviceSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - keys: - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create a new Key credential in the Fleet, optionally giving it - a friendly name and assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id004 [] - x-path-type: list - /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: - delete: - description: Delete a specific Key credential from the Fleet, effectively disallowing - any inbound client connections that are presenting it. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Key credential in the Fleet. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the given properties of a specific Key credential in the - Fleet, giving it a friendly name or assigning to a Device. - parameters: - - description: '' - in: path - name: FleetSid - required: true - schema: - type: string - - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DeviceSid: - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - maxLength: 34 - minLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /DeployedDevices/Fleets/{Sid}: - delete: - description: 'Delete a specific Fleet from your account, also destroys all nested - resources: Devices, Deployments, Certificates, Keys.' - parameters: - - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch information about a specific Fleet in your account. - parameters: - - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update the friendly name property of a specific Fleet in your account. - parameters: - - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - DefaultDeploymentSid: - description: Provides a string identifier of a Deployment that is - going to be used as a default one for this Fleet. - maxLength: 34 - minLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - type: string - FriendlyName: - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id005 - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_hosted_numbers.yaml b/spec/yaml/twilio_preview_hosted_numbers.yaml deleted file mode 100644 index befdddbc..00000000 --- a/spec/yaml/twilio_preview_hosted_numbers.yaml +++ /dev/null @@ -1,973 +0,0 @@ -components: - schemas: - preview.hosted_numbers.authorization_document: - properties: - address_sid: - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - cc_emails: - items: - type: string - type: array - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - email: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - status: - enum: - - opened - - signing - - signed - - canceled - - failed - type: string - url: - format: uri - type: string - type: object - preview.hosted_numbers.authorization_document.dependent_hosted_number_order: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - address_sid: - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - call_delay: - type: integer - capabilities: - type: object - cc_emails: - items: - type: string - type: array - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - email: - type: string - extension: - type: string - failure_reason: - type: string - friendly_name: - type: string - incoming_phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - phone_number: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - signing_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - status: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - unique_name: - type: string - verification_attempts: - type: integer - verification_call_sids: - items: - type: string - type: array - verification_code: - type: string - verification_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - verification_type: - enum: - - phone-call - - phone-bill - type: string - type: object - preview.hosted_numbers.hosted_number_order: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - address_sid: - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - call_delay: - type: integer - capabilities: - type: object - cc_emails: - items: - type: string - type: array - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - email: - type: string - extension: - type: string - failure_reason: - type: string - friendly_name: - type: string - incoming_phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - phone_number: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - signing_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - status: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - unique_name: - type: string - url: - format: uri - type: string - verification_attempts: - type: integer - verification_call_sids: - items: - type: string - type: array - verification_code: - type: string - verification_document_sid: - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - verification_type: - enum: - - phone-call - - phone-bill - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /HostedNumbers/AuthorizationDocuments: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of AuthorizationDocuments belonging to the account - initiating the request. - parameters: - - description: Email that this AuthorizationDocument will be sent to for signing. - in: query - name: Email - schema: - type: string - - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - in: query - name: Status - schema: - enum: - - opened - - signing - - signed - - canceled - - failed - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Create an AuthorizationDocument for authorizing the hosting of - phone number capabilities on Twilio's platform. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AddressSid: - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - CcEmails: - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - items: - type: string - type: array - ContactPhoneNumber: - description: The contact phone number of the person authorized to - sign the Authorization Document. - type: string - ContactTitle: - description: The title of the person authorized to sign the Authorization - Document for this phone number. - type: string - Email: - description: Email that this AuthorizationDocument will be sent - to for signing. - type: string - HostedNumberOrderSids: - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - items: - type: string - type: array - required: - - HostedNumberOrderSids - - AddressSid - - Email - - ContactTitle - - ContactPhoneNumber - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /HostedNumbers/AuthorizationDocuments/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific AuthorizationDocument. - parameters: - - description: A 34 character string that uniquely identifies this AuthorizationDocument. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates a specific AuthorizationDocument. - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AddressSid: - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - CcEmails: - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - items: - type: string - type: array - ContactPhoneNumber: - description: The contact phone number of the person authorized to - sign the Authorization Document. - type: string - ContactTitle: - description: The title of the person authorized to sign the Authorization - Document for this phone number. - type: string - Email: - description: Email that this AuthorizationDocument will be sent - to for signing. - type: string - HostedNumberOrderSids: - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - items: - type: string - type: array - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - enum: - - opened - - signing - - signed - - canceled - - failed - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. - parameters: - - description: '' - in: path - name: SigningDocumentSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - type: string - - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - in: query - name: Status - schema: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - - description: An E164 formatted phone number hosted by this HostedNumberOrder. - in: query - name: PhoneNumber - schema: - type: string - - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - in: query - name: IncomingPhoneNumberSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - - description: A human readable description of this resource, up to 64 characters. - in: query - name: FriendlyName - schema: - 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. - in: query - name: UniqueName - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: list - /HostedNumbers/HostedNumberOrders: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. - parameters: - - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. - in: query - name: Status - schema: - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - - description: An E164 formatted phone number hosted by this HostedNumberOrder. - in: query - name: PhoneNumber - schema: - type: string - - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - in: query - name: IncomingPhoneNumberSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - - description: A human readable description of this resource, up to 64 characters. - in: query - name: FriendlyName - schema: - 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. - in: query - name: UniqueName - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Host a phone number's capability on Twilio's platform. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AccountSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - AddressSid: - description: Optional. A 34 character string that uniquely identifies - the Address resource that represents the address of the owner - of this phone number. - maxLength: 34 - minLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - type: string - CcEmails: - description: Optional. A list of emails that the LOA document for - this HostedNumberOrder will be carbon copied to. - items: - type: string - type: array - Email: - description: Optional. Email of the owner of this phone number that - is being hosted. - type: string - FriendlyName: - description: A 64 character string that is a human readable text - that describes this resource. - type: string - PhoneNumber: - description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) - format - type: string - SmsApplicationSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - type: string - SmsCapability: - description: Used to specify that the SMS capability will be hosted - on Twilio's platform. - type: boolean - SmsFallbackMethod: - 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. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsFallbackUrl: - 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. - format: uri - type: string - SmsMethod: - 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. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsUrl: - description: The URL that Twilio should request when somebody sends - an SMS to the phone number. This will be copied onto the IncomingPhoneNumber - resource. - format: uri - type: string - StatusCallbackMethod: - description: Optional. The Status Callback Method attached to the - IncomingPhoneNumber resource. - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - StatusCallbackUrl: - description: Optional. The Status Callback URL attached to the IncomingPhoneNumber - resource. - format: uri - type: string - UniqueName: - 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. - type: string - VerificationDocumentSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - VerificationType: - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - enum: - - phone-call - - phone-bill - type: string - required: - - PhoneNumber - - SmsCapability - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /HostedNumbers/HostedNumberOrders/{Sid}: - delete: - description: Cancel the HostedNumberOrder (only available when the status is - in `received`). - parameters: - - description: A 34 character string that uniquely identifies this HostedNumberOrder. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific HostedNumberOrder. - parameters: - - description: A 34 character string that uniquely identifies this HostedNumberOrder. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates a specific HostedNumberOrder. - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallDelay: - description: The number of seconds, between 0 and 60, to delay before - initiating the verification call. Defaults to 0. - type: integer - CcEmails: - description: Optional. A list of emails that LOA document for this - HostedNumberOrder will be carbon copied to. - items: - type: string - type: array - Email: - description: Email of the owner of this phone number that is being - hosted. - type: string - Extension: - description: Digits to dial after connecting the verification call. - type: string - FriendlyName: - description: A 64 character string that is a human readable text - that describes this resource. - type: string - 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. - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - type: string - UniqueName: - 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. - type: string - VerificationCode: - description: A verification code that is given to the user via a - phone call to the phone number that is being hosted. - type: string - VerificationDocumentSid: - 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. - maxLength: 34 - minLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - type: string - VerificationType: - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - enum: - - phone-call - - phone-bill - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_marketplace.yaml b/spec/yaml/twilio_preview_marketplace.yaml deleted file mode 100644 index 72411bff..00000000 --- a/spec/yaml/twilio_preview_marketplace.yaml +++ /dev/null @@ -1,636 +0,0 @@ -components: - schemas: - preview.marketplace.available_add_on: - properties: - configuration_schema: - type: object - description: - type: string - friendly_name: - type: string - links: - type: object - pricing_type: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.marketplace.available_add_on.available_add_on_extension: - properties: - available_add_on_sid: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - friendly_name: - type: string - product_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.marketplace.installed_add_on: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - configuration: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - description: - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.marketplace.installed_add_on.installed_add_on_extension: - properties: - enabled: - type: boolean - friendly_name: - type: string - installed_add_on_sid: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - product_name: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /marketplace/AvailableAddOns: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Add-ons currently available to be installed. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - available_add_ons: - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Extensions for the Available Add-on. - parameters: - - description: The SID of the AvailableAddOn resource with the extensions to - read. - in: path - name: AvailableAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - extensions: - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Extension for the Available Add-on. - parameters: - - description: The SID of the AvailableAddOn resource with the extension to - fetch. - in: path - name: AvailableAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - - description: The SID of the AvailableAddOn Extension resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /marketplace/AvailableAddOns/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Add-on currently available to be installed. - parameters: - - description: The SID of the AvailableAddOn resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /marketplace/InstalledAddOns: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Add-ons currently installed on this Account. - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - installed_add_ons: - items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Install an Add-on for the Account specified. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AcceptTermsOfService: - description: Whether the Terms of Service were accepted. - type: boolean - AvailableAddOnSid: - description: The SID of the AvaliableAddOn to install. - maxLength: 34 - minLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - type: string - Configuration: - description: The JSON object that represents the configuration of - the new Add-on being installed. - type: object - UniqueName: - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - type: string - required: - - AvailableAddOnSid - - AcceptTermsOfService - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id004 [] - x-path-type: list - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of Extensions for the Installed Add-on. - parameters: - - description: The SID of the InstalledAddOn resource with the extensions to - read. - in: path - name: InstalledAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - extensions: - items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id003 [] - x-path-type: list - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Extension for the Installed Add-on. - parameters: - - description: The SID of the InstalledAddOn resource with the extension to - fetch. - in: path - name: InstalledAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - - description: The SID of the InstalledAddOn Extension resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an Extension for an Add-on installation. - parameters: - - description: The SID of the InstalledAddOn resource with the extension to - update. - in: path - name: InstalledAddOnSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - - description: The SID of the InstalledAddOn Extension resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Enabled: - description: Whether the Extension should be invoked. - type: boolean - required: - - Enabled - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /marketplace/InstalledAddOns/{Sid}: - delete: - description: Remove an Add-on installation from your account - parameters: - - description: The SID of the InstalledAddOn resource to delete. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch an instance of an Add-on currently installed on this Account. - parameters: - - description: The SID of the InstalledAddOn resource to fetch. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an Add-on installation for the Account specified. - parameters: - - description: The SID of the InstalledAddOn resource to update. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - 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 - type: object - UniqueName: - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id004 - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_sync.yaml b/spec/yaml/twilio_preview_sync.yaml deleted file mode 100644 index 328775cf..00000000 --- a/spec/yaml/twilio_preview_sync.yaml +++ /dev/null @@ -1,2139 +0,0 @@ -components: - schemas: - preview.sync.service: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - acl_enabled: - type: boolean - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - reachability_webhooks_enabled: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - webhook_url: - format: uri - type: string - type: object - preview.sync.service.document: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - data: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - links: - type: object - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service.document.document_permission: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - document_sid: - maxLength: 34 - minLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - type: string - identity: - type: string - manage: - type: boolean - read: - type: boolean - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - write: - type: boolean - type: object - preview.sync.service.sync_list: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - links: - type: object - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_list.sync_list_item: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - data: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - index: - type: integer - list_sid: - maxLength: 34 - minLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - type: string - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_list.sync_list_permission: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - identity: - type: string - list_sid: - maxLength: 34 - minLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - type: string - manage: - type: boolean - read: - type: boolean - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - write: - type: boolean - type: object - preview.sync.service.sync_map: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - links: - type: object - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_map.sync_map_item: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - created_by: - type: string - data: - type: object - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - key: - type: string - map_sid: - maxLength: 34 - minLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - type: string - revision: - type: string - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.sync.service.sync_map.sync_map_permission: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - identity: - type: string - manage: - type: boolean - map_sid: - maxLength: 34 - minLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - type: string - read: - type: boolean - service_sid: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - write: - type: boolean - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /Sync/Services: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - services: - items: - $ref: '#/components/schemas/preview.sync.service' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AclEnabled: - description: '' - type: boolean - FriendlyName: - description: '' - type: string - ReachabilityWebhooksEnabled: - description: '' - type: boolean - WebhookUrl: - description: '' - format: uri - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id009 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Documents: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - documents: - items: - $ref: '#/components/schemas/preview.sync.service.document' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Permissions applying to a Sync Document. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - permissions: - items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: - delete: - description: Delete a specific Sync Document Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Sync Document Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an identity's access to a specific Sync Document. - parameters: - - description: The unique SID identifier of the Sync Service Instance. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Document. Either a SID or a unique name. - in: path - name: DocumentSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Manage: - description: Boolean flag specifying whether the identity can delete - the Sync Document. - type: boolean - Read: - description: Boolean flag specifying whether the identity can read - the Sync Document. - type: boolean - Write: - description: Boolean flag specifying whether the identity can update - the Sync Document. - type: boolean - required: - - Read - - Write - - Manage - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /Sync/Services/{ServiceSid}/Documents/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /Sync/Services/{ServiceSid}/Lists: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - lists: - items: - $ref: '#/components/schemas/preview.sync.service.sync_list' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id005 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: query - name: Order - schema: - enum: - - asc - - desc - type: string - - description: '' - in: query - name: From - schema: - type: string - - description: '' - in: query - name: Bounds - schema: - enum: - - inclusive - - exclusive - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id003 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: path - name: Index - required: true - schema: - type: integer - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: path - name: Index - required: true - schema: - type: integer - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: ListSid - required: true - schema: - type: string - - description: '' - in: path - name: Index - required: true - schema: - type: integer - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Permissions applying to a Sync List. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - permissions: - items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id004 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: - delete: - description: Delete a specific Sync List Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Sync List Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an identity's access to a specific Sync List. - parameters: - - description: The unique SID identifier of the Sync Service Instance. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync List. Either a SID or a unique name. - in: path - name: ListSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Manage: - description: Boolean flag specifying whether the identity can delete - the Sync List. - type: boolean - Read: - description: Boolean flag specifying whether the identity can read - the Sync List. - type: boolean - Write: - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync List. - type: boolean - required: - - Read - - Write - - Manage - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /Sync/Services/{ServiceSid}/Lists/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id005 - x-path-type: instance - /Sync/Services/{ServiceSid}/Maps: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - maps: - items: - $ref: '#/components/schemas/preview.sync.service.sync_map' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - UniqueName: - description: '' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id008 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: query - name: Order - schema: - enum: - - asc - - desc - type: string - - description: '' - in: query - name: From - schema: - type: string - - description: '' - in: query - name: Bounds - schema: - enum: - - inclusive - - exclusive - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - items: - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - Key: - description: '' - type: string - required: - - Key - - Data - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id006 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: path - name: Key - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: path - name: Key - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: MapSid - required: true - schema: - type: string - - description: '' - in: path - name: Key - required: true - schema: - type: string - - description: The If-Match HTTP request header - in: header - name: If-Match - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Data: - description: '' - type: object - required: - - Data - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id006 - x-path-type: instance - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a list of all Permissions applying to a Sync Map. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - permissions: - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id007 [] - x-path-type: list - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: - delete: - description: Delete a specific Sync Map Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Sync Map Permission. - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Update an identity's access to a specific Sync Map. - parameters: - - description: The unique SID identifier of the Sync Service Instance. - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: Identifier of the Sync Map. Either a SID or a unique name. - in: path - name: MapSid - required: true - schema: - type: string - - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - in: path - name: Identity - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Manage: - description: Boolean flag specifying whether the identity can delete - the Sync Map. - type: boolean - Read: - description: Boolean flag specifying whether the identity can read - the Sync Map. - type: boolean - Write: - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync Map. - type: boolean - required: - - Read - - Write - - Manage - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id007 - x-path-type: instance - /Sync/Services/{ServiceSid}/Maps/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: ServiceSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id008 - x-path-type: instance - /Sync/Services/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - AclEnabled: - description: '' - type: boolean - FriendlyName: - description: '' - type: string - ReachabilityWebhooksEnabled: - description: '' - type: boolean - WebhookUrl: - description: '' - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id009 - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_trusted_comms.yaml b/spec/yaml/twilio_preview_trusted_comms.yaml deleted file mode 100644 index fdb0ee6c..00000000 --- a/spec/yaml/twilio_preview_trusted_comms.yaml +++ /dev/null @@ -1,926 +0,0 @@ -components: - schemas: - preview.trusted_comms.branded_call: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - bg_color: - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - branded_channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - call_sid: - maxLength: 34 - minLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - caller: - type: string - created_at: - format: date-time - type: string - font_color: - type: string - from: - type: string - logo: - type: string - phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - reason: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CQ[0-9a-fA-F]{32}$ - type: string - status: - type: string - to: - type: string - url: - format: uri - type: string - use_case: - type: string - type: object - preview.trusted_comms.branded_channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.branded_channel.channel: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - branded_channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - phone_number: - type: string - phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.brands_information: - properties: - file_link: - format: uri - type: string - file_link_ttl_in_seconds: - type: string - update_time: - format: date-time - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.business: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.business.insights: - properties: {} - type: object - preview.trusted_comms.business.insights.insights_impressions_rate: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - end: - format: date-time - type: string - interval: - enum: - - minute - - hour - - day - - week - - month - type: string - reports: - type: object - start: - format: date-time - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.cps: - properties: - cps_url: - format: uri - type: string - phone_number: - type: string - url: - format: uri - type: string - type: object - preview.trusted_comms.current_call: - properties: - bg_color: - type: string - caller: - type: string - created_at: - format: date-time - type: string - font_color: - type: string - from: - type: string - logo: - type: string - manager: - type: string - reason: - type: string - shield_img: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CQ[0-9a-fA-F]{32}$ - type: string - status: - type: string - to: - type: string - url: - format: uri - type: string - use_case: - type: string - type: object - preview.trusted_comms.phone_call: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - bg_color: - type: string - brand_sid: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - branded_channel_sid: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - business_sid: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - call_sid: - maxLength: 34 - minLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - caller: - type: string - created_at: - format: date-time - type: string - font_color: - type: string - from: - type: string - logo: - type: string - phone_number_sid: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - reason: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^CQ[0-9a-fA-F]{32}$ - type: string - status: - type: string - to: - type: string - url: - format: uri - type: string - use_case: - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels: - description: 'TODO: Resource-level docs' - post: - description: Associate a channel to a branded channel - parameters: - - description: The unique SID identifier of the Branded Channel. The given phone - number is going to be assigned to this Branded Channel - in: path - name: BrandedChannelSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - PhoneNumberSid: - description: The unique SID identifier of the Phone Number of the - Phone number to be assigned to the Branded Channel. - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - required: - - PhoneNumberSid - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.branded_channel.channel' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - business_sid - - brand_sid - - branded_channel_sid - - phone_number_sid - - phone_number - - url - x-path-type: list - /TrustedComms/BrandedChannels/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Branded Channel. - parameters: - - description: The unique SID identifier of the Branded Channel. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.branded_channel' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - business_sid - - brand_sid - - sid - - links - - url - x-path-type: instance - /TrustedComms/BrandsInformation: - description: 'TODO: Resource-level docs' - get: - description: Retrieve the newest available BrandInformation - parameters: - - description: The If-None-Match HTTP request header - in: header - name: If-None-Match - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.brands_information' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - update_time - - file_link - - file_link_ttl_in_seconds - - url - x-path-type: instance - /TrustedComms/Business/BrandedCalls: - description: 'TODO: Resource-level docs' - post: - description: Brands a Call without actually placing it. Useful for cases when - the Customer wants to initiate the call themselves right after calling this - endpoint. This can be used also through a TwiML using `+1500456`, - and right after doing `+1500456` - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallSid: - description: The Call sid this Branded Call should link to. - maxLength: 34 - minLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - From: - description: The phone number to use as the caller id, given in - [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - It must be a Twilio number that has been set up as a Branded Number - in the Business Profile section for your account. - type: string - Reason: - description: The business reason for this phone call that will appear - in the terminating device's screen. Max 50 characters. - type: string - To: - description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - type: string - required: - - From - - To - - Reason - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.branded_call' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - bg_color - - brand_sid - - branded_channel_sid - - business_sid - - call_sid - - caller - - created_at - - font_color - - from - - logo - - phone_number_sid - - reason - - sid - - status - - to - - url - - use_case - x-path-type: list - /TrustedComms/Business/PhoneCalls: - description: 'TODO: Resource-level docs' - post: - description: Initiates a Branded Call. - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - ApplicationSid: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - maxLength: 34 - minLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - type: string - CallerId: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - FallbackMethod: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - FallbackUrl: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - format: uri - type: string - From: - description: The phone number to use as the caller id, given in - [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - It must be a Twilio number that has been set up as a Branded Number - in the Business Profile section for your account. - type: string - MachineDetection: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - MachineDetectionSilenceTimeout: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - MachineDetectionSpeechEndThreshold: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - MachineDetectionSpeechThreshold: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - MachineDetectionTimeout: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - Method: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Reason: - description: The business reason for this phone call that will appear - in the terminating device's screen. Max 50 characters. - type: string - Record: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: boolean - RecordingChannels: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - RecordingStatusCallback: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - RecordingStatusCallbackEvent: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - items: - type: string - type: array - RecordingStatusCallbackMethod: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SendDigits: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - SipAuthPassword: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - SipAuthUsername: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - StatusCallback: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - format: uri - type: string - StatusCallbackEvent: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - items: - type: string - type: array - StatusCallbackMethod: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - Timeout: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: integer - To: - description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - type: string - Trim: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - type: string - Url: - description: Refers to the parameter with the same name when [initiating - a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) - format: uri - type: string - required: - - From - - To - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.phone_call' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - bg_color - - brand_sid - - branded_channel_sid - - business_sid - - call_sid - - caller - - created_at - - font_color - - from - - logo - - phone_number_sid - - reason - - sid - - status - - to - - url - - use_case - x-path-type: list - /TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Impressions Rate. - parameters: - - description: The unique SID identifier of the Business to filter by. - in: path - name: BusinessSid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - - description: The unique SID identifier of the Brand to filter by. - in: query - name: BrandSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^BZ[0-9a-fA-F]{32}$ - type: string - - description: The unique SID identifier of the Branded Channel to filter by. - in: query - name: BrandedChannelSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^BW[0-9a-fA-F]{32}$ - type: string - - description: The unique SID identifier of the Phone Number to filter by. - in: query - name: PhoneNumberSid - schema: - maxLength: 34 - minLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - type: string - - description: The 2-letter ISO 3166 code of the Country to filter by. - in: query - name: Country - schema: - type: string - - description: The start date that for this Impressions Rate, given in ISO 8601 - format. Default value is 30 days ago. - in: query - name: Start - schema: - format: date-time - type: string - - description: The end date that for this Impressions Rate, given in ISO 8601 - format. Default value is current timestamp. - in: query - name: End - schema: - format: date-time - type: string - - description: The Interval of this Impressions Rate. One of `minute`, `hour`, - `day`, `week` or `month`. - in: query - name: Interval - schema: - enum: - - minute - - hour - - day - - week - - month - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - start - - end - - interval - - business_sid - - reports - - url - x-path-type: instance - /TrustedComms/Businesses/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Business. - parameters: - - description: A 34 character string that uniquely identifies this Business. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^BX[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.business' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - account_sid - - sid - - url - - links - x-path-type: instance - /TrustedComms/CPS: - description: 'TODO: Resource-level docs' - get: - description: Fetch a specific Call Placement Service (CPS) given a phone number - via `X-XCNAM-Sensitive-Phone-Number` header. - parameters: - - description: The X-Xcnam-Sensitive-Phone-Number HTTP request header - in: header - name: X-Xcnam-Sensitive-Phone-Number - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.cps' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - cps_url - - phone_number - - url - x-path-type: instance - /TrustedComms/CurrentCall: - description: 'TODO: Resource-level docs' - get: - description: Retrieve a current call given the originating and terminating number - via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` - headers. - parameters: - - description: The X-Xcnam-Sensitive-Phone-Number-From HTTP request header - in: header - name: X-Xcnam-Sensitive-Phone-Number-From - schema: - type: string - - description: The X-Xcnam-Sensitive-Phone-Number-To HTTP request header - in: header - name: X-Xcnam-Sensitive-Phone-Number-To - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.trusted_comms.current_call' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: - - bg_color - - caller - - created_at - - font_color - - from - - logo - - manager - - reason - - shield_img - - sid - - status - - to - - url - - use_case - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_understand.yaml b/spec/yaml/twilio_preview_understand.yaml deleted file mode 100644 index 4b7905f1..00000000 --- a/spec/yaml/twilio_preview_understand.yaml +++ /dev/null @@ -1,2389 +0,0 @@ -components: - schemas: - preview.understand.assistant: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - callback_events: - type: string - callback_url: - format: uri - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - latest_model_build_sid: - maxLength: 34 - minLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - type: string - links: - type: object - log_queries: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.assistant_fallback_actions: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - url: - format: uri - type: string - type: object - preview.understand.assistant.assistant_initiation_actions: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - url: - format: uri - type: string - type: object - preview.understand.assistant.dialogue: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.field_type: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.field_type.field_value: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - field_type_sid: - maxLength: 34 - minLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ - type: string - language: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ - type: string - synonym_of: - maxLength: 34 - minLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - value: - type: string - type: object - preview.understand.assistant.model_build: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - build_duration: - nullable: true - type: integer - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - error_code: - nullable: true - type: integer - sid: - maxLength: 34 - minLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - type: string - status: - enum: - - enqueued - - building - - completed - - failed - - canceled - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.query: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - language: - type: string - model_build_sid: - maxLength: 34 - minLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - type: string - query: - type: string - results: - type: object - sample_sid: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UH[0-9a-fA-F]{32}$ - type: string - source_channel: - type: string - status: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.style_sheet: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - url: - format: uri - type: string - type: object - preview.understand.assistant.task: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - actions_url: - format: uri - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - links: - type: object - sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.field: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - field_type: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UE[0-9a-fA-F]{32}$ - type: string - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.sample: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - language: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - source_channel: - type: string - tagged_text: - type: string - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.task_actions: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - data: - type: object - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - preview.understand.assistant.task.task_statistics: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - assistant_sid: - maxLength: 34 - minLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - type: string - fields_count: - type: integer - samples_count: - type: integer - task_sid: - maxLength: 34 - minLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /understand/Assistants: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - assistants: - items: - $ref: '#/components/schemas/preview.understand.assistant' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackEvents: - description: Space-separated list of callback events that will trigger - callbacks. - type: string - CallbackUrl: - description: A user-provided URL to send event callbacks to. - format: uri - type: string - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - type: object - FriendlyName: - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - type: string - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - type: object - LogQueries: - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - type: boolean - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - type: object - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id008 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.dialogue' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/FallbackActions: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FallbackActions: - description: '' - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/FieldTypes: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - field_types: - items: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - UniqueName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - - description: 'An ISO language-country string of the value. For example: *en-US*' - in: query - name: Language - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - field_values: - items: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Language: - description: An ISO language-country string of the value. - type: string - SynonymOf: - description: A value that indicates this field value is a synonym - of. Empty if the value is not a synonym. - type: string - Value: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - Language - - Value - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: FieldTypeSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /understand/Assistants/{AssistantSid}/InitiationActions: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - InitiationActions: - description: '' - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/ModelBuilds: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - model_builds: - items: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - StatusCallback: - description: '' - format: uri - type: string - UniqueName: - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' - type: string - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id003 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: AssistantSid - required: true - schema: - type: string - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - UniqueName: - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Queries: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: An ISO language-country string of the sample. - in: query - name: Language - schema: - type: string - - description: The Model Build Sid or unique name of the Model Build to be queried. - in: query - name: ModelBuild - schema: - type: string - - description: 'A string that described the query status. The values can be: - pending_review, reviewed, discarded' - in: query - name: Status - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - queries: - items: - $ref: '#/components/schemas/preview.understand.assistant.query' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Field: - description: Constraints the query to a given Field with an task. - Useful when you know the Field you are expecting. It accepts one - field in the format *task-unique-name-1*:*field-unique-name* - type: string - Language: - description: An ISO language-country string of the sample. - type: string - ModelBuild: - description: The Model Build Sid or unique name of the Model Build - to be queried. - type: string - Query: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. It can be up to 2048 characters - long. - type: string - Tasks: - description: Constraints the query to a set of tasks. Useful when - you need to constrain the paths the user can take. Tasks should - be comma separated *task-unique-name-1*, *task-unique-name-2* - type: string - required: - - Language - - Query - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id004 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Queries/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - SampleSid: - description: An optional reference to the Sample created from this - query. - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - Status: - description: 'A string that described the query status. The values - can be: pending_review, reviewed, discarded' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id004 - x-path-type: instance - /understand/Assistants/{AssistantSid}/StyleSheet: - description: 'TODO: Resource-level docs' - get: - description: Returns Style sheet JSON object for this Assistant - parameters: - - description: The unique ID of the Assistant - in: path - name: AssistantSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates the style sheet for an assistant identified by {AssistantSid} - or {AssistantUniqueName}. - parameters: - - description: The unique ID of the Assistant - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - StyleSheet: - description: The JSON Style sheet string - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - tasks: - items: - $ref: '#/components/schemas/preview.understand.assistant.task' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - type: object - ActionsUrl: - description: User-provided HTTP endpoint where from the assistant - fetches actions - format: uri - type: string - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - UniqueName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id005 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Tasks/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - type: object - ActionsUrl: - description: User-provided HTTP endpoint where from the assistant - fetches actions - format: uri - type: string - FriendlyName: - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id005 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: - description: 'TODO: Resource-level docs' - get: - description: Returns JSON actions for this Task. - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task. - in: path - name: TaskSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task. - in: path - name: TaskSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Actions: - description: The JSON actions that instruct the Assistant how to - perform this task. - type: object - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - fields: - items: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FieldType: - description: The unique name or sid of the FieldType. It can be - any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) - or the unique_name or the Field Type sid of a custom Field Type. - type: string - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - required: - - FieldType - - UniqueName - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id006 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id006 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: An ISO language-country string of the sample. - in: query - name: Language - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - samples: - items: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Language: - description: An ISO language-country string of the sample. - type: string - SourceChannel: - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - type: string - TaggedText: - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - type: string - required: - - Language - - TaggedText - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id007 [] - x-path-type: list - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: - delete: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: The unique ID of the Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Sample. - in: path - name: TaskSid - required: true - schema: - type: string - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - Language: - description: An ISO language-country string of the sample. - type: string - SourceChannel: - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - type: string - TaggedText: - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id007 - x-path-type: instance - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: The unique ID of the parent Assistant. - in: path - name: AssistantSid - required: true - schema: - type: string - - description: The unique ID of the Task associated with this Field. - in: path - name: TaskSid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance - /understand/Assistants/{Sid}: - delete: - description: '' - parameters: - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: A 34 character string that uniquely identifies this resource. - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackEvents: - description: Space-separated list of callback events that will trigger - callbacks. - type: string - CallbackUrl: - description: A user-provided URL to send event callbacks to. - format: uri - type: string - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - type: object - FriendlyName: - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - type: string - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - type: object - LogQueries: - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - type: boolean - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - type: object - UniqueName: - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id008 - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_preview_wireless.yaml b/spec/yaml/twilio_preview_wireless.yaml deleted file mode 100644 index b7275d12..00000000 --- a/spec/yaml/twilio_preview_wireless.yaml +++ /dev/null @@ -1,862 +0,0 @@ -components: - schemas: - preview.wireless.command: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - command: - type: string - command_mode: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - device_sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - direction: - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - type: string - sim_sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - status: - type: string - url: - format: uri - type: string - type: object - preview.wireless.rate_plan: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - data_enabled: - type: boolean - data_limit: - type: integer - data_metering: - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - friendly_name: - type: string - international_roaming: - items: - type: string - type: array - messaging_enabled: - type: boolean - national_roaming_enabled: - type: boolean - sid: - maxLength: 34 - minLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ - type: string - unique_name: - type: string - url: - format: uri - type: string - voice_enabled: - type: boolean - type: object - preview.wireless.sim: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - commands_callback_method: - type: string - commands_callback_url: - format: uri - type: string - date_created: - format: date-time - type: string - date_updated: - format: date-time - type: string - e_id: - type: string - friendly_name: - type: string - iccid: - type: string - links: - type: object - rate_plan_sid: - maxLength: 34 - minLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ - type: string - sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - sms_fallback_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - sms_fallback_url: - format: uri - type: string - sms_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - sms_url: - format: uri - type: string - status: - type: string - unique_name: - type: string - url: - format: uri - type: string - voice_fallback_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - voice_fallback_url: - format: uri - type: string - voice_method: - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - voice_url: - format: uri - type: string - type: object - preview.wireless.sim.usage: - properties: - account_sid: - maxLength: 34 - minLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - type: string - commands_costs: - type: object - commands_usage: - type: object - data_costs: - type: object - data_usage: - type: object - period: - type: object - sim_sid: - maxLength: 34 - minLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - type: string - sim_unique_name: - type: string - url: - format: uri - type: string - type: object - securitySchemes: - accountSid_authToken: - scheme: basic - type: http -info: - contact: - email: support@twilio.com - name: Twilio Support - url: https://support.twilio.com - description: This is the public Twilio REST API. - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - termsOfService: https://www.twilio.com/legal/tos - title: Twilio - Preview - version: 1.3.0 -openapi: 3.0.1 -paths: - /wireless/Commands: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: query - name: Device - schema: - type: string - - description: '' - in: query - name: Sim - schema: - type: string - - description: '' - in: query - name: Status - schema: - type: string - - description: '' - in: query - name: Direction - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - commands: - items: - $ref: '#/components/schemas/preview.wireless.command' - type: array - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackMethod: - description: '' - type: string - CallbackUrl: - description: '' - format: uri - type: string - Command: - description: '' - type: string - CommandMode: - description: '' - type: string - Device: - description: '' - type: string - IncludeSid: - description: '' - type: string - Sim: - description: '' - type: string - required: - - Command - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.command' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id001 [] - x-path-type: list - /wireless/Commands/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - maxLength: 34 - minLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.command' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id001 - x-path-type: instance - /wireless/RatePlans: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - rate_plans: - items: - $ref: '#/components/schemas/preview.wireless.rate_plan' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CommandsEnabled: - description: '' - type: boolean - DataEnabled: - description: '' - type: boolean - DataLimit: - description: '' - type: integer - DataMetering: - description: '' - type: string - FriendlyName: - description: '' - type: string - InternationalRoaming: - description: '' - items: - type: string - type: array - MessagingEnabled: - description: '' - type: boolean - NationalRoamingEnabled: - description: '' - type: boolean - UniqueName: - description: '' - type: string - VoiceEnabled: - description: '' - type: boolean - type: object - responses: - 201: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: Created - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id002 [] - x-path-type: list - /wireless/RatePlans/{Sid}: - delete: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 204: - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - tags: - - Preview - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - FriendlyName: - description: '' - type: string - UniqueName: - description: '' - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id002 - x-path-type: instance - /wireless/Sims: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: query - name: Status - schema: - type: string - - description: '' - in: query - name: Iccid - schema: - type: string - - description: '' - in: query - name: RatePlan - schema: - type: string - - description: '' - in: query - name: EId - schema: - type: string - - description: '' - in: query - name: SimRegistrationCode - schema: - type: string - - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - in: query - name: PageSize - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - 200: - content: - application/json: - schema: - properties: - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - type: string - url: - format: uri - type: string - type: object - sims: - items: - $ref: '#/components/schemas/preview.wireless.sim' - type: array - type: object - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: &id003 [] - x-path-type: list - /wireless/Sims/{Sid}: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - post: - description: '' - parameters: - - description: '' - in: path - name: Sid - required: true - schema: - type: string - requestBody: - content: - application/x-www-form-urlencoded: - schema: - properties: - CallbackMethod: - description: '' - type: string - CallbackUrl: - description: '' - format: uri - type: string - CommandsCallbackMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - CommandsCallbackUrl: - description: '' - format: uri - type: string - FriendlyName: - description: '' - type: string - RatePlan: - description: '' - type: string - SmsFallbackMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsFallbackUrl: - description: '' - format: uri - type: string - SmsMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - SmsUrl: - description: '' - format: uri - type: string - Status: - description: '' - type: string - UniqueName: - description: '' - type: string - VoiceFallbackMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - VoiceFallbackUrl: - description: '' - format: uri - type: string - VoiceMethod: - description: '' - enum: - - head - - get - - post - - patch - - put - - delete - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - type: string - VoiceUrl: - description: '' - format: uri - type: string - type: object - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: *id003 - x-path-type: instance - /wireless/Sims/{SimSid}/Usage: - description: 'TODO: Resource-level docs' - get: - description: '' - parameters: - - description: '' - in: path - name: SimSid - required: true - schema: - type: string - - description: '' - in: query - name: End - schema: - type: string - - description: '' - in: query - name: Start - schema: - type: string - responses: - 200: - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim.usage' - description: OK - security: - - accountSid_authToken: [] - tags: - - Preview - servers: - - url: https://preview.twilio.com - x-default-output-properties: [] - x-path-type: instance -tags: -- description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. - name: Preview diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index 088a8d8e..10005619 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -211,7 +211,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Messaging/Countries: diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index e33f4289..d0ffa8b8 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/Voice/Countries: diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index e5c78019..e3fb7c09 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -493,7 +493,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Proxy - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index e8d1f250..3e14bc39 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -457,7 +457,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Serverless - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index 6c7338e1..f108cf54 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -320,7 +320,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Flows: diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 4db8b7a4..afe19eb1 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -257,7 +257,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/Flows: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 0587b7da..c87dc621 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -255,7 +255,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Supersim - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Commands: diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index a477a1bb..a4d184c4 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -381,7 +381,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Sync - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 1bdacb55..9f5bbe81 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1041,7 +1041,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Taskrouter - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Workspaces: diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index cf9567db..1e0fcc16 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -323,14 +323,6 @@ components: - trim-silence - do-not-trim type: string - trunk_sid: - maxLength: 34 - minLength: 34 - pattern: ^TK[0-9a-fA-F]{32}$ - type: string - url: - format: uri - type: string type: object securitySchemes: accountSid_authToken: @@ -347,7 +339,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Trunking - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Trunks: @@ -1431,7 +1423,7 @@ paths: post: description: '' parameters: - - description: '' + - description: The SID of the Trunk that will have its recording settings updated. in: path name: TrunkSid required: true @@ -1444,7 +1436,25 @@ paths: content: application/x-www-form-urlencoded: schema: - properties: {} + properties: + Mode: + description: The recording mode for the trunk. Can be do-not-record + (default), record-from-ringing, record-from-answer, record-from-ringing-dual, + or record-from-answer-dual. + enum: + - do-not-record + - record-from-ringing + - record-from-answer + - record-from-ringing-dual + - record-from-answer-dual + type: string + Trim: + description: The recording trim setting for the trunk. Can be do-not-trim + (default) or trim-silence. + enum: + - trim-silence + - do-not-trim + type: string type: object responses: 202: diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index af4622bc..6806b83e 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -455,7 +455,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Verify - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v2/Forms/{FormType}: diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 93eee66e..1e2a12e5 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -579,7 +579,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Video - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/CompositionHooks: diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index a7b5a2ba..c165e10b 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -295,7 +295,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Voice - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/ByocTrunks: diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index 0c2721f9..e40ade82 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -330,7 +330,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Wireless - version: 1.3.0 + version: 5.12.0 openapi: 3.0.1 paths: /v1/Commands: From 8c7de5bd8ca5814607a3ef42ff6a43ff6794a346 Mon Sep 17 00:00:00 2001 From: shwetharadhakrishna Date: Mon, 30 Nov 2020 13:59:57 -0700 Subject: [PATCH 4/7] Updated version --- spec/json/twilio_accounts_v1.json | 2 +- spec/json/twilio_api_v2010.json | 2 +- spec/json/twilio_autopilot_v1.json | 2 +- spec/json/twilio_bulkexports_v1.json | 2 +- spec/json/twilio_chat_v1.json | 2 +- spec/json/twilio_chat_v2.json | 2 +- spec/json/twilio_conversations_v1.json | 2 +- spec/json/twilio_events_v1.json | 2 +- spec/json/twilio_fax_v1.json | 2 +- spec/json/twilio_flex_v1.json | 2 +- spec/json/twilio_insights_v1.json | 2 +- spec/json/twilio_ip_messaging_v1.json | 2 +- spec/json/twilio_ip_messaging_v2.json | 2 +- spec/json/twilio_lookups_v1.json | 2 +- spec/json/twilio_messaging_v1.json | 2 +- spec/json/twilio_monitor_v1.json | 2 +- spec/json/twilio_notify_v1.json | 2 +- spec/json/twilio_numbers_v2.json | 2 +- spec/json/twilio_pricing_v1.json | 2 +- spec/json/twilio_pricing_v2.json | 2 +- spec/json/twilio_proxy_v1.json | 2 +- spec/json/twilio_serverless_v1.json | 2 +- spec/json/twilio_studio_v1.json | 2 +- 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 | 2 +- spec/json/twilio_trunking_v1.json | 2 +- spec/json/twilio_verify_v2.json | 2 +- spec/json/twilio_video_v1.json | 2 +- spec/json/twilio_voice_v1.json | 2 +- spec/json/twilio_wireless_v1.json | 2 +- spec/yaml/twilio_accounts_v1.yaml | 2 +- spec/yaml/twilio_api_v2010.yaml | 2 +- spec/yaml/twilio_autopilot_v1.yaml | 2 +- spec/yaml/twilio_bulkexports_v1.yaml | 2 +- spec/yaml/twilio_chat_v1.yaml | 2 +- spec/yaml/twilio_chat_v2.yaml | 2 +- spec/yaml/twilio_conversations_v1.yaml | 2 +- spec/yaml/twilio_events_v1.yaml | 2 +- spec/yaml/twilio_fax_v1.yaml | 2 +- spec/yaml/twilio_flex_v1.yaml | 2 +- spec/yaml/twilio_insights_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v2.yaml | 2 +- spec/yaml/twilio_lookups_v1.yaml | 2 +- spec/yaml/twilio_messaging_v1.yaml | 2 +- spec/yaml/twilio_monitor_v1.yaml | 2 +- spec/yaml/twilio_notify_v1.yaml | 2 +- spec/yaml/twilio_numbers_v2.yaml | 2 +- spec/yaml/twilio_pricing_v1.yaml | 2 +- spec/yaml/twilio_pricing_v2.yaml | 2 +- spec/yaml/twilio_proxy_v1.yaml | 2 +- spec/yaml/twilio_serverless_v1.yaml | 2 +- spec/yaml/twilio_studio_v1.yaml | 2 +- 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 | 2 +- spec/yaml/twilio_trunking_v1.yaml | 2 +- spec/yaml/twilio_verify_v2.yaml | 2 +- spec/yaml/twilio_video_v1.yaml | 2 +- spec/yaml/twilio_voice_v1.yaml | 2 +- spec/yaml/twilio_wireless_v1.yaml | 2 +- 64 files changed, 64 insertions(+), 64 deletions(-) diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 660d99cc..f43d12f8 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -142,7 +142,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Accounts", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 0da72def..8d1348a0 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -7230,7 +7230,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Api", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json index 25acdd25..78cff008 100644 --- a/spec/json/twilio_autopilot_v1.json +++ b/spec/json/twilio_autopilot_v1.json @@ -690,7 +690,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Autopilot", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index 4b7d38bc..361aaf61 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -162,7 +162,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Bulkexports", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index 09bd3f7c..50f36a52 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -551,7 +551,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Chat", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index 3c5c0493..b48df12a 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -764,7 +764,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Chat", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index f7431d3a..97ded778 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -1111,7 +1111,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Conversations", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index d15bdc7c..be39955a 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -227,7 +227,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Events", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_fax_v1.json b/spec/json/twilio_fax_v1.json index 52fba4e2..17f1ee15 100644 --- a/spec/json/twilio_fax_v1.json +++ b/spec/json/twilio_fax_v1.json @@ -154,7 +154,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Fax", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 4ff6f88b..159b9353 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -343,7 +343,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Flex", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index d9dc0b91..b73f2510 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -518,7 +518,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Insights", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index 70e9fbef..ca8f3ae8 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -551,7 +551,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Ip_messaging", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index e5919c27..dda02371 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -764,7 +764,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Ip_messaging", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index bf64fc4e..88ec1a8d 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -49,7 +49,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Lookups", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index d0219f7c..06c30409 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -279,7 +279,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Messaging", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index 797fba1b..83d1830a 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -257,7 +257,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Monitor", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 09baff7f..65d7496b 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -304,7 +304,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Notify", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index c3908ecf..c6be4c34 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -358,7 +358,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Numbers", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index 180048a9..d182c612 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -320,7 +320,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index e30ad1f6..ff7abe66 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -174,7 +174,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Pricing", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 41a9e95e..068fefa5 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -628,7 +628,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Proxy", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 6495ac9d..f3385b73 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -601,7 +601,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Serverless", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index d0886428..4eb30e00 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -425,7 +425,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Studio", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index 7911cffe..d78744c4 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -351,7 +351,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Studio", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 27de475f..302a8059 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -341,7 +341,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Supersim", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 784f0140..0da7a034 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -516,7 +516,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Sync", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index 24eb7da1..ae901e8d 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -1401,7 +1401,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Taskrouter", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index 8ff59a98..6c979ebd 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -438,7 +438,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Trunking", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 5561ff30..1f492d3f 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -616,7 +616,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Verify", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 22ac2118..309afb69 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -774,7 +774,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Video", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 887398e8..0c9e54a7 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -398,7 +398,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Voice", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index cee2c01e..40f556c8 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -438,7 +438,7 @@ }, "termsOfService": "https://www.twilio.com/legal/tos", "title": "Twilio - Wireless", - "version": "5.12.0" + "version": "1.3.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 2a710173..3a73edba 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -104,7 +104,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Accounts - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index c4a626c7..afb60f10 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -6066,7 +6066,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Api - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml index 81b36a09..01e80b3d 100644 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -520,7 +520,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Autopilot - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Assistants: diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 07652f12..99215a4b 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -110,7 +110,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Bulkexports - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Exports/Jobs/{JobSid}: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index a378da19..25512aee 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -412,7 +412,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index 1fb2df88..580fa909 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -572,7 +572,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Credentials: diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 19f704ea..e0364752 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -837,7 +837,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Conversations - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Configuration: diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 00ffe8c3..b75238ea 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -161,7 +161,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Events - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Schemas/{Id}: diff --git a/spec/yaml/twilio_fax_v1.yaml b/spec/yaml/twilio_fax_v1.yaml index 561647bb..447e6fc6 100644 --- a/spec/yaml/twilio_fax_v1.yaml +++ b/spec/yaml/twilio_fax_v1.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Fax - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Faxes: diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 530506e7..602e3a5e 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -256,7 +256,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Flex - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Channels: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 889e8cf9..aec94222 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -390,7 +390,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Insights - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Video/Rooms: diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 045fe450..4f7565d2 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -412,7 +412,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Ip_messaging - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index 9e4cda1f..c589ba4d 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -572,7 +572,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Ip_messaging - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Credentials: diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 0817ede5..268f7759 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -33,7 +33,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Lookups - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index f42cbc31..8582f85d 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -209,7 +209,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Messaging - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Deactivations: diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index 3184ace7..c1f10d2b 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -194,7 +194,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Monitor - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Alerts: diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 29d4d99b..8307ed43 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -221,7 +221,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Notify - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Credentials: diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index be40fc51..49e79265 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -265,7 +265,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Numbers - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/RegulatoryCompliance/Bundles: diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index 10005619..088a8d8e 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -211,7 +211,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Messaging/Countries: diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index d0ffa8b8..e33f4289 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -115,7 +115,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Pricing - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Voice/Countries: diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index e3fb7c09..e5c78019 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -493,7 +493,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Proxy - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index 3e14bc39..e8d1f250 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -457,7 +457,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Serverless - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index f108cf54..6c7338e1 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -320,7 +320,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Flows: diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index afe19eb1..4db8b7a4 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -257,7 +257,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Studio - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Flows: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index c87dc621..0587b7da 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -255,7 +255,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Supersim - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Commands: diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index a4d184c4..a477a1bb 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -381,7 +381,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Sync - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Services: diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 9f5bbe81..1bdacb55 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1041,7 +1041,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Taskrouter - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Workspaces: diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 1e0fcc16..5916d847 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -339,7 +339,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Trunking - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Trunks: diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 6806b83e..af4622bc 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -455,7 +455,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Verify - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v2/Forms/{FormType}: diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 1e2a12e5..93eee66e 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -579,7 +579,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Video - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/CompositionHooks: diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index c165e10b..a7b5a2ba 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -295,7 +295,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Voice - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/ByocTrunks: diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index e40ade82..0c2721f9 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -330,7 +330,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Wireless - version: 5.12.0 + version: 1.3.0 openapi: 3.0.1 paths: /v1/Commands: From 2d56882d8f2d25c00d042f7084054c52f7c439f0 Mon Sep 17 00:00:00 2001 From: shwetharadhakrishna Date: Mon, 30 Nov 2020 14:35:51 -0700 Subject: [PATCH 5/7] Adding .gitignore --- .gitignore | 1 + spec/json/twilio_api_v2010.json | 3 --- spec/json/twilio_trunking_v1.json | 34 +++++++++++-------------------- spec/yaml/twilio_api_v2010.yaml | 2 -- spec/yaml/twilio_trunking_v1.yaml | 30 +++++++++------------------ 5 files changed, 23 insertions(+), 47 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..e43b0f98 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 8d1348a0..34ca449f 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -1337,9 +1337,6 @@ ], "type": "string" }, - "track": { - "type": "string" - }, "uri": { "format": "uri", "type": "string" diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index 6c979ebd..d78486a5 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -413,6 +413,16 @@ "do-not-trim" ], "type": "string" + }, + "trunk_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TK[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" } }, "type": "object" @@ -1982,7 +1992,7 @@ "description": "", "parameters": [ { - "description": "The SID of the Trunk that will have its recording settings updated.", + "description": "", "in": "path", "name": "TrunkSid", "required": true, @@ -1998,27 +2008,7 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { - "Mode": { - "description": "The recording mode for the trunk. Can be do-not-record (default), record-from-ringing, record-from-answer, record-from-ringing-dual, or record-from-answer-dual.", - "enum": [ - "do-not-record", - "record-from-ringing", - "record-from-answer", - "record-from-ringing-dual", - "record-from-answer-dual" - ], - "type": "string" - }, - "Trim": { - "description": "The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence.", - "enum": [ - "trim-silence", - "do-not-trim" - ], - "type": "string" - } - }, + "properties": {}, "type": "object" } } diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index afb60f10..398aed30 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -995,8 +995,6 @@ components: - completed - absent type: string - track: - type: string uri: format: uri type: string diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 5916d847..cf9567db 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -323,6 +323,14 @@ components: - trim-silence - do-not-trim type: string + trunk_sid: + maxLength: 34 + minLength: 34 + pattern: ^TK[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string type: object securitySchemes: accountSid_authToken: @@ -1423,7 +1431,7 @@ paths: post: description: '' parameters: - - description: The SID of the Trunk that will have its recording settings updated. + - description: '' in: path name: TrunkSid required: true @@ -1436,25 +1444,7 @@ paths: content: application/x-www-form-urlencoded: schema: - properties: - Mode: - description: The recording mode for the trunk. Can be do-not-record - (default), record-from-ringing, record-from-answer, record-from-ringing-dual, - or record-from-answer-dual. - enum: - - do-not-record - - record-from-ringing - - record-from-answer - - record-from-ringing-dual - - record-from-answer-dual - type: string - Trim: - description: The recording trim setting for the trunk. Can be do-not-trim - (default) or trim-silence. - enum: - - trim-silence - - do-not-trim - type: string + properties: {} type: object responses: 202: From c24df41c4d761afa16c8908da07e75891b187494 Mon Sep 17 00:00:00 2001 From: shwetharadhakrishna Date: Mon, 30 Nov 2020 19:20:25 -0700 Subject: [PATCH 6/7] Removing .DS_Store --- spec/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 spec/.DS_Store diff --git a/spec/.DS_Store b/spec/.DS_Store deleted file mode 100644 index 297d2a8e589769a1660daf6dc57cdba0928243b9..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKPfrs;6n_Inwnb$5Q=!pAV`D-B2T&p!L#PF#4KY+oumrH|wo6&r&NRDQYN<8- z3SKqd_2j{$U%>bUJQ+WNUOnlXKP~_C;=vfQFPZthdGp?zzTfWbbO3;)s>Nvl9RM_J z977T8ej|LIw^P!kEIo*X=SVxOU^>jiF;5ssz(Byj|IGm3yCHZ29x$LM_U~<+8~-Up z6w&cBYhFd|^G{~Qu|0ok>NDx;4)vVt)wGBf>5pt>cUdj#8-CSG8SVxjWek7URQf7o zPDeM)HQTD?^^pZeeZ!`fD}wE!g)WVig}BnpW!-^cguch;;W{%c3IR^3IND`MJD4;1yivI2q>I zzRl?Rk=gZ44|z}fRyj>~7_PXFJTF(co401U9^$F^+`8eq1}#~s`j%suma|M#%=cND zd-7}rMl-I(Gv#d5c`b?g?~=tta;dG1OGSr-RPYSZ$tq>k3WpQPj52C40e9d5tic`} zzzcW{@8AP`gfH+7evn=gBUi`-nIUszp4=yCvP3fEAz6{pUF}DCxxIu$vVqunl>1qi zI*gXk#{EN32LsCBoOs#a0(8GQ^0LcRXS!GPX?NO>RQ@fAG8~9l8S|)> ziMpW>b@3o^;SMAzG3WyZ0tSvV&@G2LKmYII9{$7q|9DU^3K$3&I8zLe&|-Emg(a!8 z^;B{Etc_#a#>R#FwIqrV?9_2A6n+$sVH1LLajqaH6}BXz1ts_+AZQ4>fPsI?z%MA! B Date: Tue, 1 Dec 2020 09:45:51 -0700 Subject: [PATCH 7/7] Adding in preview specs --- spec/json/twilio_preview.json | 13803 ++++++++++++++++++++++++++++++++ spec/yaml/twilio_preview.yaml | 9460 ++++++++++++++++++++++ 2 files changed, 23263 insertions(+) create mode 100644 spec/json/twilio_preview.json create mode 100644 spec/yaml/twilio_preview.yaml diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json new file mode 100644 index 00000000..d9afda2f --- /dev/null +++ b/spec/json/twilio_preview.json @@ -0,0 +1,13803 @@ +{ + "components": { + "schemas": { + "preview.bulk_exports.export": { + "properties": { + "links": { + "type": "object" + }, + "resource_type": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.day": { + "properties": { + "create_date": { + "type": "string" + }, + "day": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.day|instance": { + "properties": { + "redirect_to": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.export_custom_job": { + "properties": { + "details": { + "type": "object" + }, + "email": { + "type": "string" + }, + "end_day": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "job_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "start_day": { + "type": "string" + }, + "webhook_method": { + "type": "string" + }, + "webhook_url": { + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export.job": { + "properties": { + "details": { + "type": "object" + }, + "email": { + "type": "string" + }, + "end_day": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "job_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "start_day": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_method": { + "type": "string" + }, + "webhook_url": { + "type": "string" + } + }, + "type": "object" + }, + "preview.bulk_exports.export_configuration": { + "properties": { + "enabled": { + "type": "boolean" + }, + "resource_type": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_method": { + "type": "string" + }, + "webhook_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "default_deployment_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.certificate": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "device_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + }, + "thumbprint": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.deployment": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "sync_service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.device": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_authenticated": { + "format": "date-time", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "deployment_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "identity": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.deployed_devices.fleet.key": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "device_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "fleet_sid": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "secret": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.hosted_numbers.authorization_document": { + "properties": { + "address_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "cc_emails": { + "items": { + "type": "string" + }, + "type": "array" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "address_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_delay": { + "type": "integer" + }, + "capabilities": { + "type": "object" + }, + "cc_emails": { + "items": { + "type": "string" + }, + "type": "array" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string" + }, + "extension": { + "type": "string" + }, + "failure_reason": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "incoming_phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + }, + "signing_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "verification_attempts": { + "type": "integer" + }, + "verification_call_sids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "verification_code": { + "type": "string" + }, + "verification_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "verification_type": { + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + }, + "preview.hosted_numbers.hosted_number_order": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "address_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_delay": { + "type": "integer" + }, + "capabilities": { + "type": "object" + }, + "cc_emails": { + "items": { + "type": "string" + }, + "type": "array" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string" + }, + "extension": { + "type": "string" + }, + "failure_reason": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "incoming_phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + }, + "signing_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "verification_attempts": { + "type": "integer" + }, + "verification_call_sids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "verification_code": { + "type": "string" + }, + "verification_document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "verification_type": { + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.available_add_on": { + "properties": { + "configuration_schema": { + "type": "object" + }, + "description": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "pricing_type": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.available_add_on.available_add_on_extension": { + "properties": { + "available_add_on_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "product_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.installed_add_on": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "configuration": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "description": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.marketplace.installed_add_on.installed_add_on_extension": { + "properties": { + "enabled": { + "type": "boolean" + }, + "friendly_name": { + "type": "string" + }, + "installed_add_on_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + }, + "product_name": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "acl_enabled": { + "type": "boolean" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "reachability_webhooks_enabled": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "webhook_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.document": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "data": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ET[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.document.document_permission": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "document_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ET[0-9a-fA-F]{32}$", + "type": "string" + }, + "identity": { + "type": "string" + }, + "manage": { + "type": "boolean" + }, + "read": { + "type": "boolean" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "write": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.sync.service.sync_list": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_list.sync_list_item": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "data": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "index": { + "type": "integer" + }, + "list_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "type": "string" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_list.sync_list_permission": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "identity": { + "type": "string" + }, + "list_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "type": "string" + }, + "manage": { + "type": "boolean" + }, + "read": { + "type": "boolean" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "write": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.sync.service.sync_map": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "links": { + "type": "object" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MP[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_map.sync_map_item": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "data": { + "type": "object" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "key": { + "type": "string" + }, + "map_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MP[0-9a-fA-F]{32}$", + "type": "string" + }, + "revision": { + "type": "string" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.sync.service.sync_map.sync_map_permission": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "identity": { + "type": "string" + }, + "manage": { + "type": "boolean" + }, + "map_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^MP[0-9a-fA-F]{32}$", + "type": "string" + }, + "read": { + "type": "boolean" + }, + "service_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "write": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.trusted_comms.branded_call": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "bg_color": { + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "branded_channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "caller": { + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "font_color": { + "type": "string" + }, + "from": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "reason": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CQ[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "use_case": { + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.branded_channel": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.branded_channel.channel": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "branded_channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.brands_information": { + "properties": { + "file_link": { + "format": "uri", + "type": "string" + }, + "file_link_ttl_in_seconds": { + "type": "string" + }, + "update_time": { + "format": "date-time", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.business": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.business.insights": { + "properties": {}, + "type": "object" + }, + "preview.trusted_comms.business.insights.insights_impressions_rate": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "end": { + "format": "date-time", + "type": "string" + }, + "interval": { + "enum": [ + "minute", + "hour", + "day", + "week", + "month" + ], + "type": "string" + }, + "reports": { + "type": "object" + }, + "start": { + "format": "date-time", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.cps": { + "properties": { + "cps_url": { + "format": "uri", + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.current_call": { + "properties": { + "bg_color": { + "type": "string" + }, + "caller": { + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "font_color": { + "type": "string" + }, + "from": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "shield_img": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CQ[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "use_case": { + "type": "string" + } + }, + "type": "object" + }, + "preview.trusted_comms.phone_call": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "bg_color": { + "type": "string" + }, + "brand_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + }, + "branded_channel_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + }, + "business_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + }, + "call_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "caller": { + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "font_color": { + "type": "string" + }, + "from": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "phone_number_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + }, + "reason": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CQ[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "use_case": { + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "callback_events": { + "type": "string" + }, + "callback_url": { + "format": "uri", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "latest_model_build_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "type": "string" + }, + "links": { + "type": "object" + }, + "log_queries": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.assistant_fallback_actions": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.assistant_initiation_actions": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.dialogue": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UK[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.field_type": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.field_type.field_value": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "field_type_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "type": "string" + }, + "language": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "type": "string" + }, + "synonym_of": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.model_build": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "build_duration": { + "nullable": true, + "type": "integer" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "error_code": { + "nullable": true, + "type": "integer" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "enum": [ + "enqueued", + "building", + "completed", + "failed", + "canceled" + ], + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.query": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "language": { + "type": "string" + }, + "model_build_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "type": "string" + }, + "query": { + "type": "string" + }, + "results": { + "type": "object" + }, + "sample_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UH[0-9a-fA-F]{32}$", + "type": "string" + }, + "source_channel": { + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.style_sheet": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "actions_url": { + "format": "uri", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "links": { + "type": "object" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.field": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "field_type": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UE[0-9a-fA-F]{32}$", + "type": "string" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.sample": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "language": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "source_channel": { + "type": "string" + }, + "tagged_text": { + "type": "string" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.task_actions": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "data": { + "type": "object" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.understand.assistant.task.task_statistics": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "assistant_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "type": "string" + }, + "fields_count": { + "type": "integer" + }, + "samples_count": { + "type": "integer" + }, + "task_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.wireless.command": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "command": { + "type": "string" + }, + "command_mode": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "device_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "direction": { + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$", + "type": "string" + }, + "sim_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.wireless.rate_plan": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "data_enabled": { + "type": "boolean" + }, + "data_limit": { + "type": "integer" + }, + "data_metering": { + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "international_roaming": { + "items": { + "type": "string" + }, + "type": "array" + }, + "messaging_enabled": { + "type": "boolean" + }, + "national_roaming_enabled": { + "type": "boolean" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WP[0-9a-fA-F]{32}$", + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "voice_enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "preview.wireless.sim": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "commands_callback_method": { + "type": "string" + }, + "commands_callback_url": { + "format": "uri", + "type": "string" + }, + "date_created": { + "format": "date-time", + "type": "string" + }, + "date_updated": { + "format": "date-time", + "type": "string" + }, + "e_id": { + "type": "string" + }, + "friendly_name": { + "type": "string" + }, + "iccid": { + "type": "string" + }, + "links": { + "type": "object" + }, + "rate_plan_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WP[0-9a-fA-F]{32}$", + "type": "string" + }, + "sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "sms_fallback_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "sms_fallback_url": { + "format": "uri", + "type": "string" + }, + "sms_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "sms_url": { + "format": "uri", + "type": "string" + }, + "status": { + "type": "string" + }, + "unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + }, + "voice_fallback_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "voice_fallback_url": { + "format": "uri", + "type": "string" + }, + "voice_method": { + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "voice_url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "preview.wireless.sim.usage": { + "properties": { + "account_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "commands_costs": { + "type": "object" + }, + "commands_usage": { + "type": "object" + }, + "data_costs": { + "type": "object" + }, + "data_usage": { + "type": "object" + }, + "period": { + "type": "object" + }, + "sim_sid": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "type": "string" + }, + "sim_unique_name": { + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + }, + "info": { + "contact": { + "email": "support@twilio.com", + "name": "Twilio Support", + "url": "https://support.twilio.com" + }, + "description": "This is the public Twilio REST API.", + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://www.twilio.com/legal/tos", + "title": "Twilio - Preview", + "version": "1.3.0" + }, + "openapi": "3.0.1", + "paths": { + "/BulkExports/Exports/Jobs/{JobSid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique string that that we created to identify the Bulk Export job", + "in": "path", + "name": "JobSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "JobSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^JS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export.job" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Export.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}/Configuration": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Export Configuration.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update a specific Export Configuration.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "If true, Twilio will automatically generate every day's file when the day is over.", + "type": "boolean" + }, + "WebhookMethod": { + "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", + "type": "string" + }, + "WebhookUrl": { + "description": "Stores the URL destination for the method specified in webhook_method.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}/Days": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Days for a resource.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "days": { + "items": { + "$ref": "#/components/schemas/preview.bulk_exports.export.day" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/BulkExports/Exports/{ResourceType}/Days/{Day}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Day.", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The ISO 8601 format date of the resources in the file, for a UTC day", + "in": "path", + "name": "Day", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "307": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export.day|instance" + } + } + }, + "description": "Temporary Redirect" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/BulkExports/Exports/{ResourceType}/Jobs": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The type of communication \u2013 Messages, Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "jobs": { + "items": { + "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The type of communication \u2013 Messages or Calls", + "in": "path", + "name": "ResourceType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Email": { + "description": "The optional email to send the completion notification to", + "type": "string" + }, + "EndDay": { + "description": "The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.", + "type": "string" + }, + "FriendlyName": { + "description": "The friendly name specified when creating the job", + "type": "string" + }, + "StartDay": { + "description": "The start day for the custom export specified as a string in the format of yyyy-mm-dd", + "type": "string" + }, + "WebhookMethod": { + "description": "This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.", + "type": "string" + }, + "WebhookUrl": { + "description": "The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied.", + "type": "string" + } + }, + "required": [ + "StartDay", + "EndDay", + "FriendlyName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Fleets belonging to your account.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "fleets": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create a new Fleet for scoping of deployed devices within your account.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "in": "query", + "name": "DeviceSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificates": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CertificateData": { + "description": "Provides a URL encoded representation of the public certificate in PEM format.", + "type": "string" + }, + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", + "type": "string" + } + }, + "required": [ + "CertificateData" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "delete": { + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Certificate credential in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Deployments belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "deployments": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long.", + "type": "string" + }, + "SyncServiceSid": { + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { + "delete": { + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Deployment in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long", + "type": "string" + }, + "SyncServiceSid": { + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Devices belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", + "in": "query", + "name": "DeploymentSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "devices": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "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.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeploymentSid": { + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "Enabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", + "type": "string" + }, + "Identity": { + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", + "type": "string" + }, + "UniqueName": { + "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.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { + "delete": { + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Device in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeploymentSid": { + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "Enabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", + "type": "string" + }, + "Identity": { + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", + "in": "query", + "name": "DeviceSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "keys": { + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "delete": { + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Key credential in the Fleet.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "FleetSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/DeployedDevices/Fleets/{Sid}": { + "delete": { + "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "parameters": [ + { + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch information about a specific Fleet in your account.", + "parameters": [ + { + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update the friendly name property of a specific Fleet in your account.", + "parameters": [ + { + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DefaultDeploymentSid": { + "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/HostedNumbers/AuthorizationDocuments": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "parameters": [ + { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "in": "query", + "name": "Email", + "schema": { + "type": "string" + } + }, + { + "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "in": "query", + "name": "Status", + "schema": { + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ContactPhoneNumber": { + "description": "The contact phone number of the person authorized to sign the Authorization Document.", + "type": "string" + }, + "ContactTitle": { + "description": "The title of the person authorized to sign the Authorization Document for this phone number.", + "type": "string" + }, + "Email": { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "type": "string" + }, + "HostedNumberOrderSids": { + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific AuthorizationDocument.", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates a specific AuthorizationDocument.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", + "items": { + "type": "string" + }, + "type": "array" + }, + "ContactPhoneNumber": { + "description": "The contact phone number of the person authorized to sign the Authorization Document.", + "type": "string" + }, + "ContactTitle": { + "description": "The title of the person authorized to sign the Authorization Document for this phone number.", + "type": "string" + }, + "Email": { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "type": "string" + }, + "HostedNumberOrderSids": { + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "SigningDocumentSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "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/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "in": "query", + "name": "Status", + "schema": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + } + }, + { + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "in": "query", + "name": "PhoneNumber", + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "in": "query", + "name": "IncomingPhoneNumberSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "A human readable description of this resource, up to 64 characters.", + "in": "query", + "name": "FriendlyName", + "schema": { + "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.", + "in": "query", + "name": "UniqueName", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/HostedNumbers/HostedNumberOrders": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "parameters": [ + { + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "in": "query", + "name": "Status", + "schema": { + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + } + }, + { + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "in": "query", + "name": "PhoneNumber", + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "in": "query", + "name": "IncomingPhoneNumberSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "A human readable description of this resource, up to 64 characters.", + "in": "query", + "name": "FriendlyName", + "schema": { + "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.", + "in": "query", + "name": "UniqueName", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Host a phone number's capability on Twilio's platform.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "AddressSid": { + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Email": { + "description": "Optional. Email of the owner of this phone number that is being hosted.", + "type": "string" + }, + "FriendlyName": { + "description": "A 64 character string that is a human readable text that describes this resource.", + "type": "string" + }, + "PhoneNumber": { + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format", + "type": "string" + }, + "SmsApplicationSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsCapability": { + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform.", + "type": "boolean" + }, + "SmsFallbackMethod": { + "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.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "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.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "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.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "StatusCallbackUrl": { + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "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.", + "type": "string" + }, + "VerificationDocumentSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "VerificationType": { + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/HostedNumbers/HostedNumberOrders/{Sid}": { + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific HostedNumberOrder.", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates a specific HostedNumberOrder.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallDelay": { + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.", + "type": "integer" + }, + "CcEmails": { + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Email": { + "description": "Email of the owner of this phone number that is being hosted.", + "type": "string" + }, + "Extension": { + "description": "Digits to dial after connecting the verification call.", + "type": "string" + }, + "FriendlyName": { + "description": "A 64 character string that is a human readable text that describes this resource.", + "type": "string" + }, + "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.", + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "UniqueName": { + "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.", + "type": "string" + }, + "VerificationCode": { + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted.", + "type": "string" + }, + "VerificationDocumentSid": { + "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.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "VerificationType": { + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "services": { + "items": { + "$ref": "#/components/schemas/preview.sync.service" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "ReachabilityWebhooksEnabled": { + "description": "", + "type": "boolean" + }, + "WebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Documents": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "documents": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.document" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync Document.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { + "delete": { + "description": "Delete a specific Sync Document Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Sync Document Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync Document.", + "parameters": [ + { + "description": "The unique SID identifier of the Sync Service Instance.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "in": "path", + "name": "DocumentSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync Document.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync Document.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can update the Sync Document.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Lists": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "lists": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Order", + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "From", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Bounds", + "schema": { + "enum": [ + "inclusive", + "exclusive" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Index", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Index", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Index", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync List.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "delete": { + "description": "Delete a specific Sync List Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Sync List Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync List.", + "parameters": [ + { + "description": "The unique SID identifier of the Sync Service Instance.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "in": "path", + "name": "ListSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync List.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync List.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Lists/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Maps": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "maps": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Order", + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "From", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Bounds", + "schema": { + "enum": [ + "inclusive", + "exclusive" + ], + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + }, + "Key": { + "description": "", + "type": "string" + } + }, + "required": [ + "Key", + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Key", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Key", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Key", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The If-Match HTTP request header", + "in": "header", + "name": "If-Match", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { + "delete": { + "description": "Delete a specific Sync Map Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Sync Map Permission.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync Map.", + "parameters": [ + { + "description": "The unique SID identifier of the Sync Service Instance.", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "in": "path", + "name": "MapSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "in": "path", + "name": "Identity", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync Map.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync Map.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "ServiceSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/Sync/Services/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "ReachabilityWebhooksEnabled": { + "description": "", + "type": "boolean" + }, + "WebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels": { + "description": "TODO: Resource-level docs", + "post": { + "description": "Associate a channel to a branded channel", + "parameters": [ + { + "description": "The unique SID identifier of the Branded Channel. The given phone number is going to be assigned to this Branded Channel", + "in": "path", + "name": "BrandedChannelSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "PhoneNumberSid": { + "description": "The unique SID identifier of the Phone Number of the Phone number to be assigned to the Branded Channel.", + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "PhoneNumberSid" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.branded_channel.channel" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "business_sid", + "brand_sid", + "branded_channel_sid", + "phone_number_sid", + "phone_number", + "url" + ], + "x-path-type": "list" + }, + "/TrustedComms/BrandedChannels/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Branded Channel.", + "parameters": [ + { + "description": "The unique SID identifier of the Branded Channel.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.branded_channel" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "business_sid", + "brand_sid", + "sid", + "links", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/BrandsInformation": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve the newest available BrandInformation", + "parameters": [ + { + "description": "The If-None-Match HTTP request header", + "in": "header", + "name": "If-None-Match", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.brands_information" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "update_time", + "file_link", + "file_link_ttl_in_seconds", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/Business/BrandedCalls": { + "description": "TODO: Resource-level docs", + "post": { + "description": "Brands a Call without actually placing it. Useful for cases when the Customer wants to initiate the call themselves right after calling this endpoint. This can be used also through a TwiML using `+1500456`, and right after doing `+1500456`", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallSid": { + "description": "The Call sid this Branded Call should link to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "From": { + "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", + "type": "string" + }, + "Reason": { + "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", + "type": "string" + }, + "To": { + "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + } + }, + "required": [ + "From", + "To", + "Reason" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.branded_call" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "bg_color", + "brand_sid", + "branded_channel_sid", + "business_sid", + "call_sid", + "caller", + "created_at", + "font_color", + "from", + "logo", + "phone_number_sid", + "reason", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "list" + }, + "/TrustedComms/Business/PhoneCalls": { + "description": "TODO: Resource-level docs", + "post": { + "description": "Initiates a Branded Call.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApplicationSid": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "CallerId": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "FallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackUrl": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + }, + "From": { + "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", + "type": "string" + }, + "MachineDetection": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "MachineDetectionSilenceTimeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionSpeechEndThreshold": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionSpeechThreshold": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionTimeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "Method": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Reason": { + "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", + "type": "string" + }, + "Record": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "boolean" + }, + "RecordingChannels": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "RecordingStatusCallbackEvent": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "items": { + "type": "string" + }, + "type": "array" + }, + "RecordingStatusCallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SendDigits": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "SipAuthPassword": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "SipAuthUsername": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "StatusCallback": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "items": { + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Timeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "To": { + "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + }, + "Trim": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "Url": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + } + }, + "required": [ + "From", + "To" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.phone_call" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "bg_color", + "brand_sid", + "branded_channel_sid", + "business_sid", + "call_sid", + "caller", + "created_at", + "font_color", + "from", + "logo", + "phone_number_sid", + "reason", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "list" + }, + "/TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Impressions Rate.", + "parameters": [ + { + "description": "The unique SID identifier of the Business to filter by.", + "in": "path", + "name": "BusinessSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique SID identifier of the Brand to filter by.", + "in": "query", + "name": "BrandSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BZ[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique SID identifier of the Branded Channel to filter by.", + "in": "query", + "name": "BrandedChannelSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The unique SID identifier of the Phone Number to filter by.", + "in": "query", + "name": "PhoneNumberSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The 2-letter ISO 3166 code of the Country to filter by.", + "in": "query", + "name": "Country", + "schema": { + "type": "string" + } + }, + { + "description": "The start date that for this Impressions Rate, given in ISO 8601 format. Default value is 30 days ago.", + "in": "query", + "name": "Start", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "The end date that for this Impressions Rate, given in ISO 8601 format. Default value is current timestamp.", + "in": "query", + "name": "End", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "The Interval of this Impressions Rate. One of `minute`, `hour`, `day`, `week` or `month`.", + "in": "query", + "name": "Interval", + "schema": { + "enum": [ + "minute", + "hour", + "day", + "week", + "month" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "start", + "end", + "interval", + "business_sid", + "reports", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/Businesses/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Business.", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this Business.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.business" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "sid", + "url", + "links" + ], + "x-path-type": "instance" + }, + "/TrustedComms/CPS": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Call Placement Service (CPS) given a phone number via `X-XCNAM-Sensitive-Phone-Number` header.", + "parameters": [ + { + "description": "The X-Xcnam-Sensitive-Phone-Number HTTP request header", + "in": "header", + "name": "X-Xcnam-Sensitive-Phone-Number", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.cps" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "cps_url", + "phone_number", + "url" + ], + "x-path-type": "instance" + }, + "/TrustedComms/CurrentCall": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a current call given the originating and terminating number via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` headers.", + "parameters": [ + { + "description": "The X-Xcnam-Sensitive-Phone-Number-From HTTP request header", + "in": "header", + "name": "X-Xcnam-Sensitive-Phone-Number-From", + "schema": { + "type": "string" + } + }, + { + "description": "The X-Xcnam-Sensitive-Phone-Number-To HTTP request header", + "in": "header", + "name": "X-Xcnam-Sensitive-Phone-Number-To", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.current_call" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "bg_color", + "caller", + "created_at", + "font_color", + "from", + "logo", + "manager", + "reason", + "shield_img", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "instance" + }, + "/marketplace/AvailableAddOns": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Add-ons currently available to be installed.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "available_add_ons": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Extensions for the Available Add-on.", + "parameters": [ + { + "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "in": "path", + "name": "AvailableAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "extensions": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Extension for the Available Add-on.", + "parameters": [ + { + "description": "The SID of the AvailableAddOn resource with the extension to fetch.", + "in": "path", + "name": "AvailableAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the AvailableAddOn Extension resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/marketplace/AvailableAddOns/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Add-on currently available to be installed.", + "parameters": [ + { + "description": "The SID of the AvailableAddOn resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/marketplace/InstalledAddOns": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Add-ons currently installed on this Account.", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "installed_add_ons": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Install an Add-on for the Account specified.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AcceptTermsOfService": { + "description": "Whether the Terms of Service were accepted.", + "type": "boolean" + }, + "AvailableAddOnSid": { + "description": "The SID of the AvaliableAddOn to install.", + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed.", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", + "type": "string" + } + }, + "required": [ + "AvailableAddOnSid", + "AcceptTermsOfService" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of Extensions for the Installed Add-on.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource with the extensions to read.", + "in": "path", + "name": "InstalledAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "extensions": { + "items": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Extension for the Installed Add-on.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource with the extension to fetch.", + "in": "path", + "name": "InstalledAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an Extension for an Add-on installation.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource with the extension to update.", + "in": "path", + "name": "InstalledAddOnSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the InstalledAddOn Extension resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "Whether the Extension should be invoked.", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/marketplace/InstalledAddOns/{Sid}": { + "delete": { + "description": "Remove an Add-on installation from your account", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Add-on currently installed on this Account.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Update an Add-on installation for the Account specified.", + "parameters": [ + { + "description": "The SID of the InstalledAddOn resource to update.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "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", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "assistants": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Space-separated list of callback events that will trigger callbacks.", + "type": "string" + }, + "CallbackUrl": { + "description": "A user-provided URL to send event callbacks to.", + "format": "uri", + "type": "string" + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", + "type": "object" + }, + "FriendlyName": { + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", + "type": "object" + }, + "LogQueries": { + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant", + "type": "object" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.dialogue" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/FallbackActions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FallbackActions": { + "description": "", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "field_types": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "An ISO language-country string of the value. For example: *en-US*", + "in": "query", + "name": "Language", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "field_values": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the value.", + "type": "string" + }, + "SynonymOf": { + "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.", + "type": "string" + }, + "Value": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "Language", + "Value" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "FieldTypeSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/InitiationActions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "InitiationActions": { + "description": "", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/ModelBuilds": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "model_builds": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StatusCallback": { + "description": "", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Queries": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "An ISO language-country string of the sample.", + "in": "query", + "name": "Language", + "schema": { + "type": "string" + } + }, + { + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "in": "query", + "name": "ModelBuild", + "schema": { + "type": "string" + } + }, + { + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "in": "query", + "name": "Status", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "queries": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Field": { + "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*", + "type": "string" + }, + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "ModelBuild": { + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "type": "string" + }, + "Query": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.", + "type": "string" + }, + "Tasks": { + "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*", + "type": "string" + } + }, + "required": [ + "Language", + "Query" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "SampleSid": { + "description": "An optional reference to the Sample created from this query.", + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "Status": { + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/StyleSheet": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Returns Style sheet JSON object for this Assistant", + "parameters": [ + { + "description": "The unique ID of the Assistant", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", + "parameters": [ + { + "description": "The unique ID of the Assistant", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StyleSheet": { + "description": "The JSON Style sheet string", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "tasks": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "User-provided HTTP endpoint where from the assistant fetches actions", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "User-provided HTTP endpoint where from the assistant fetches actions", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Returns JSON actions for this Task.", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "The JSON actions that instruct the Assistant how to perform this task.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "fields": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FieldType": { + "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FieldType", + "UniqueName" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "An ISO language-country string of the sample.", + "in": "query", + "name": "Language", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "samples": { + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", + "type": "string" + } + }, + "required": [ + "Language", + "TaggedText" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Sample.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The unique ID of the parent Assistant.", + "in": "path", + "name": "AssistantSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique ID of the Task associated with this Field.", + "in": "path", + "name": "TaskSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/understand/Assistants/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Space-separated list of callback events that will trigger callbacks.", + "type": "string" + }, + "CallbackUrl": { + "description": "A user-provided URL to send event callbacks to.", + "format": "uri", + "type": "string" + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", + "type": "object" + }, + "FriendlyName": { + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", + "type": "object" + }, + "LogQueries": { + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant", + "type": "object" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/Commands": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "query", + "name": "Device", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Sim", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Status", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Direction", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "commands": { + "items": { + "$ref": "#/components/schemas/preview.wireless.command" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "", + "type": "string" + }, + "CallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "Command": { + "description": "", + "type": "string" + }, + "CommandMode": { + "description": "", + "type": "string" + }, + "Device": { + "description": "", + "type": "string" + }, + "IncludeSid": { + "description": "", + "type": "string" + }, + "Sim": { + "description": "", + "type": "string" + } + }, + "required": [ + "Command" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.command" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/wireless/Commands/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.command" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/RatePlans": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "rate_plans": { + "items": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommandsEnabled": { + "description": "", + "type": "boolean" + }, + "DataEnabled": { + "description": "", + "type": "boolean" + }, + "DataLimit": { + "description": "", + "type": "integer" + }, + "DataMetering": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "InternationalRoaming": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + }, + "MessagingEnabled": { + "description": "", + "type": "boolean" + }, + "NationalRoamingEnabled": { + "description": "", + "type": "boolean" + }, + "UniqueName": { + "description": "", + "type": "string" + }, + "VoiceEnabled": { + "description": "", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/wireless/RatePlans/{Sid}": { + "delete": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/Sims": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "query", + "name": "Status", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Iccid", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "RatePlan", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "EId", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "SimRegistrationCode", + "schema": { + "type": "string" + } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "sims": { + "items": { + "$ref": "#/components/schemas/preview.wireless.sim" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "list" + }, + "/wireless/Sims/{Sid}": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "", + "type": "string" + }, + "CallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "CommandsCallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CommandsCallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "RatePlan": { + "description": "", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "Status": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + }, + "VoiceFallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/wireless/Sims/{SimSid}/Usage": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "", + "in": "path", + "name": "SimSid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "End", + "schema": { + "type": "string" + } + }, + { + "description": "", + "in": "query", + "name": "Start", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.sim.usage" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + } + }, + "tags": [ + { + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", + "name": "Preview" + } + ] +} \ No newline at end of file diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml new file mode 100644 index 00000000..28e752f8 --- /dev/null +++ b/spec/yaml/twilio_preview.yaml @@ -0,0 +1,9460 @@ +components: + schemas: + preview.bulk_exports.export: + properties: + links: + type: object + resource_type: + type: string + url: + format: uri + type: string + type: object + preview.bulk_exports.export.day: + properties: + create_date: + type: string + day: + type: string + friendly_name: + type: string + resource_type: + type: string + size: + type: integer + type: object + preview.bulk_exports.export.day|instance: + properties: + redirect_to: + format: uri + type: string + type: object + preview.bulk_exports.export.export_custom_job: + properties: + details: + type: object + email: + type: string + end_day: + type: string + friendly_name: + type: string + job_sid: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + resource_type: + type: string + start_day: + type: string + webhook_method: + type: string + webhook_url: + type: string + type: object + preview.bulk_exports.export.job: + properties: + details: + type: object + email: + type: string + end_day: + type: string + friendly_name: + type: string + job_sid: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + resource_type: + type: string + start_day: + type: string + url: + format: uri + type: string + webhook_method: + type: string + webhook_url: + type: string + type: object + preview.bulk_exports.export_configuration: + properties: + enabled: + type: boolean + resource_type: + type: string + url: + format: uri + type: string + webhook_method: + type: string + webhook_url: + format: uri + type: string + type: object + preview.deployed_devices.fleet: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + default_deployment_sid: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.certificate: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + device_sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + fleet_sid: + type: string + friendly_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + thumbprint: + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.deployment: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + fleet_sid: + type: string + friendly_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + sync_service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.device: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_authenticated: + format: date-time + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + deployment_sid: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + enabled: + type: boolean + fleet_sid: + type: string + friendly_name: + type: string + identity: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.deployed_devices.fleet.key: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + device_sid: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + fleet_sid: + type: string + friendly_name: + type: string + secret: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.hosted_numbers.authorization_document: + properties: + address_sid: + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + cc_emails: + items: + type: string + type: array + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + email: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + status: + enum: + - opened + - signing + - signed + - canceled + - failed + type: string + url: + format: uri + type: string + type: object + preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + address_sid: + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + call_delay: + type: integer + capabilities: + type: object + cc_emails: + items: + type: string + type: array + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + email: + type: string + extension: + type: string + failure_reason: + type: string + friendly_name: + type: string + incoming_phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + phone_number: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + signing_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + status: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + unique_name: + type: string + verification_attempts: + type: integer + verification_call_sids: + items: + type: string + type: array + verification_code: + type: string + verification_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + verification_type: + enum: + - phone-call + - phone-bill + type: string + type: object + preview.hosted_numbers.hosted_number_order: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + address_sid: + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + call_delay: + type: integer + capabilities: + type: object + cc_emails: + items: + type: string + type: array + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + email: + type: string + extension: + type: string + failure_reason: + type: string + friendly_name: + type: string + incoming_phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + phone_number: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + signing_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + status: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + unique_name: + type: string + url: + format: uri + type: string + verification_attempts: + type: integer + verification_call_sids: + items: + type: string + type: array + verification_code: + type: string + verification_document_sid: + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + verification_type: + enum: + - phone-call + - phone-bill + type: string + type: object + preview.marketplace.available_add_on: + properties: + configuration_schema: + type: object + description: + type: string + friendly_name: + type: string + links: + type: object + pricing_type: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.marketplace.available_add_on.available_add_on_extension: + properties: + available_add_on_sid: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + friendly_name: + type: string + product_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.marketplace.installed_add_on: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + configuration: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + description: + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.marketplace.installed_add_on.installed_add_on_extension: + properties: + enabled: + type: boolean + friendly_name: + type: string + installed_add_on_sid: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + product_name: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + acl_enabled: + type: boolean + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + reachability_webhooks_enabled: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + webhook_url: + format: uri + type: string + type: object + preview.sync.service.document: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + data: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + links: + type: object + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^ET[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service.document.document_permission: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + document_sid: + maxLength: 34 + minLength: 34 + pattern: ^ET[0-9a-fA-F]{32}$ + type: string + identity: + type: string + manage: + type: boolean + read: + type: boolean + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + write: + type: boolean + type: object + preview.sync.service.sync_list: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + links: + type: object + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_list.sync_list_item: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + data: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + index: + type: integer + list_sid: + maxLength: 34 + minLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ + type: string + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_list.sync_list_permission: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + identity: + type: string + list_sid: + maxLength: 34 + minLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ + type: string + manage: + type: boolean + read: + type: boolean + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + write: + type: boolean + type: object + preview.sync.service.sync_map: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + links: + type: object + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_map.sync_map_item: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + created_by: + type: string + data: + type: object + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + key: + type: string + map_sid: + maxLength: 34 + minLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ + type: string + revision: + type: string + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.sync.service.sync_map.sync_map_permission: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + identity: + type: string + manage: + type: boolean + map_sid: + maxLength: 34 + minLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ + type: string + read: + type: boolean + service_sid: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + write: + type: boolean + type: object + preview.trusted_comms.branded_call: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + bg_color: + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + branded_channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + call_sid: + maxLength: 34 + minLength: 34 + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + caller: + type: string + created_at: + format: date-time + type: string + font_color: + type: string + from: + type: string + logo: + type: string + phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + reason: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CQ[0-9a-fA-F]{32}$ + type: string + status: + type: string + to: + type: string + url: + format: uri + type: string + use_case: + type: string + type: object + preview.trusted_comms.branded_channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.branded_channel.channel: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + branded_channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + phone_number: + type: string + phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.brands_information: + properties: + file_link: + format: uri + type: string + file_link_ttl_in_seconds: + type: string + update_time: + format: date-time + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.business: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.business.insights: + properties: {} + type: object + preview.trusted_comms.business.insights.insights_impressions_rate: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + end: + format: date-time + type: string + interval: + enum: + - minute + - hour + - day + - week + - month + type: string + reports: + type: object + start: + format: date-time + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.cps: + properties: + cps_url: + format: uri + type: string + phone_number: + type: string + url: + format: uri + type: string + type: object + preview.trusted_comms.current_call: + properties: + bg_color: + type: string + caller: + type: string + created_at: + format: date-time + type: string + font_color: + type: string + from: + type: string + logo: + type: string + manager: + type: string + reason: + type: string + shield_img: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CQ[0-9a-fA-F]{32}$ + type: string + status: + type: string + to: + type: string + url: + format: uri + type: string + use_case: + type: string + type: object + preview.trusted_comms.phone_call: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + bg_color: + type: string + brand_sid: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + branded_channel_sid: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + business_sid: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + call_sid: + maxLength: 34 + minLength: 34 + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + caller: + type: string + created_at: + format: date-time + type: string + font_color: + type: string + from: + type: string + logo: + type: string + phone_number_sid: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + reason: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^CQ[0-9a-fA-F]{32}$ + type: string + status: + type: string + to: + type: string + url: + format: uri + type: string + use_case: + type: string + type: object + preview.understand.assistant: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + callback_events: + type: string + callback_url: + format: uri + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + latest_model_build_sid: + maxLength: 34 + minLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + type: string + links: + type: object + log_queries: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.assistant_fallback_actions: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + url: + format: uri + type: string + type: object + preview.understand.assistant.assistant_initiation_actions: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + url: + format: uri + type: string + type: object + preview.understand.assistant.dialogue: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^UK[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.field_type: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.field_type.field_value: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + field_type_sid: + maxLength: 34 + minLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ + type: string + language: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ + type: string + synonym_of: + maxLength: 34 + minLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + value: + type: string + type: object + preview.understand.assistant.model_build: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + build_duration: + nullable: true + type: integer + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + error_code: + nullable: true + type: integer + sid: + maxLength: 34 + minLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + type: string + status: + enum: + - enqueued + - building + - completed + - failed + - canceled + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.query: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + language: + type: string + model_build_sid: + maxLength: 34 + minLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + type: string + query: + type: string + results: + type: object + sample_sid: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UH[0-9a-fA-F]{32}$ + type: string + source_channel: + type: string + status: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.style_sheet: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + url: + format: uri + type: string + type: object + preview.understand.assistant.task: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + actions_url: + format: uri + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + links: + type: object + sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.field: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + field_type: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UE[0-9a-fA-F]{32}$ + type: string + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.sample: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + language: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + source_channel: + type: string + tagged_text: + type: string + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.task_actions: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + data: + type: object + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.understand.assistant.task.task_statistics: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + assistant_sid: + maxLength: 34 + minLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + type: string + fields_count: + type: integer + samples_count: + type: integer + task_sid: + maxLength: 34 + minLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + type: string + url: + format: uri + type: string + type: object + preview.wireless.command: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + command: + type: string + command_mode: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + device_sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + direction: + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ + type: string + sim_sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + status: + type: string + url: + format: uri + type: string + type: object + preview.wireless.rate_plan: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + data_enabled: + type: boolean + data_limit: + type: integer + data_metering: + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + friendly_name: + type: string + international_roaming: + items: + type: string + type: array + messaging_enabled: + type: boolean + national_roaming_enabled: + type: boolean + sid: + maxLength: 34 + minLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + type: string + unique_name: + type: string + url: + format: uri + type: string + voice_enabled: + type: boolean + type: object + preview.wireless.sim: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + commands_callback_method: + type: string + commands_callback_url: + format: uri + type: string + date_created: + format: date-time + type: string + date_updated: + format: date-time + type: string + e_id: + type: string + friendly_name: + type: string + iccid: + type: string + links: + type: object + rate_plan_sid: + maxLength: 34 + minLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + type: string + sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + sms_fallback_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + sms_fallback_url: + format: uri + type: string + sms_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + sms_url: + format: uri + type: string + status: + type: string + unique_name: + type: string + url: + format: uri + type: string + voice_fallback_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + voice_fallback_url: + format: uri + type: string + voice_method: + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + voice_url: + format: uri + type: string + type: object + preview.wireless.sim.usage: + properties: + account_sid: + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + commands_costs: + type: object + commands_usage: + type: object + data_costs: + type: object + data_usage: + type: object + period: + type: object + sim_sid: + maxLength: 34 + minLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + type: string + sim_unique_name: + type: string + url: + format: uri + type: string + type: object + securitySchemes: + accountSid_authToken: + scheme: basic + type: http +info: + contact: + email: support@twilio.com + name: Twilio Support + url: https://support.twilio.com + description: This is the public Twilio REST API. + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + termsOfService: https://www.twilio.com/legal/tos + title: Twilio - Preview + version: 1.3.0 +openapi: 3.0.1 +paths: + /BulkExports/Exports/Jobs/{JobSid}: + delete: + description: '' + parameters: + - description: The unique string that that we created to identify the Bulk Export + job + in: path + name: JobSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: JobSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^JS[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export.job' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /BulkExports/Exports/{ResourceType}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Export. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /BulkExports/Exports/{ResourceType}/Configuration: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Export Configuration. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export_configuration' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update a specific Export Configuration. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Enabled: + description: If true, Twilio will automatically generate every day's + file when the day is over. + type: boolean + WebhookMethod: + description: Sets whether Twilio should call a webhook URL when + the automatic generation is complete, using GET or POST. The actual + destination is set in the webhook_url + type: string + WebhookUrl: + description: Stores the URL destination for the method specified + in webhook_method. + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export_configuration' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /BulkExports/Exports/{ResourceType}/Days: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Days for a resource. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + days: + items: + $ref: '#/components/schemas/preview.bulk_exports.export.day' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id001 [] + x-path-type: list + /BulkExports/Exports/{ResourceType}/Days/{Day}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Day. + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + - description: The ISO 8601 format date of the resources in the file, for a + UTC day + in: path + name: Day + required: true + schema: + type: string + responses: + 307: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export.day|instance' + description: Temporary Redirect + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id001 + x-path-type: instance + /BulkExports/Exports/{ResourceType}/Jobs: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: "The type of communication \u2013 Messages, Calls" + in: path + name: ResourceType + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + jobs: + items: + $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: "The type of communication \u2013 Messages or Calls" + in: path + name: ResourceType + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Email: + description: The optional email to send the completion notification + to + type: string + EndDay: + description: The end day for the custom export specified as a string + in the format of yyyy-mm-dd. End day is inclusive and must be + 2 days earlier than the current UTC day. + type: string + FriendlyName: + description: The friendly name specified when creating the job + type: string + StartDay: + description: The start day for the custom export specified as a + string in the format of yyyy-mm-dd + type: string + WebhookMethod: + description: This is the method used to call the webhook on completion + of the job. If this is supplied, `WebhookUrl` must also be supplied. + type: string + WebhookUrl: + description: The optional webhook url called on completion of the + job. If this is supplied, `WebhookMethod` must also be supplied. + type: string + required: + - StartDay + - EndDay + - FriendlyName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.bulk_exports.export.export_custom_job' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: list + /DeployedDevices/Fleets: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Fleets belonging to your account. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + fleets: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create a new Fleet for scoping of deployed devices within your + account. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id006 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Certificates: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Certificate credentials belonging to the + Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Filters the resulting list of Certificates by a unique string + identifier of an authenticated Device. + in: query + name: DeviceSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + certificates: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Enroll a new Certificate credential to the Fleet, optionally giving + it a friendly name and assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CertificateData: + description: Provides a URL encoded representation of the public + certificate in PEM format. + type: string + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + type: string + required: + - CertificateData + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id002 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: + delete: + description: Unregister a specific Certificate credential from the Fleet, effectively + disallowing any inbound client connections that are presenting it. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Certificate credential in the + Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Certificate credential + in the Fleet, giving it a friendly name or assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id002 + x-path-type: instance + /DeployedDevices/Fleets/{FleetSid}/Deployments: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Deployments belonging to the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + deployments: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create a new Deployment in the Fleet, optionally giving it a friendly + name and linking to a specific Twilio Sync service instance. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: Provides a human readable descriptive text for this + Deployment, up to 256 characters long. + type: string + SyncServiceSid: + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id003 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: + delete: + description: Delete a specific Deployment from the Fleet, leaving associated + devices effectively undeployed. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Deployment in the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Deployment credential + in the Fleet, giving it a friendly name or linking to a specific Twilio Sync + service instance. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: Provides a human readable descriptive text for this + Deployment, up to 64 characters long + type: string + SyncServiceSid: + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id003 + x-path-type: instance + /DeployedDevices/Fleets/{FleetSid}/Devices: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Devices belonging to the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Filters the resulting list of Devices by a unique string identifier + of the Deployment they are associated with. + in: query + name: DeploymentSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + devices: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + 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. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeploymentSid: + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + Enabled: + description: '' + type: boolean + FriendlyName: + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + type: string + Identity: + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + type: string + UniqueName: + 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. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id004 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: + delete: + description: Delete a specific Device from the Fleet, also removing it from + associated Deployments. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Device resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Device in the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Device resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Device in the Fleet, + giving it a friendly name, assigning to a Deployment, or a human identity. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Device resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeploymentSid: + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + Enabled: + description: '' + type: boolean + FriendlyName: + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + type: string + Identity: + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id004 + x-path-type: instance + /DeployedDevices/Fleets/{FleetSid}/Keys: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Keys credentials belonging to the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Filters the resulting list of Keys by a unique string identifier + of an authenticated Device. + in: query + name: DeviceSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + keys: + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create a new Key credential in the Fleet, optionally giving it + a friendly name and assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id005 [] + x-path-type: list + /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: + delete: + description: Delete a specific Key credential from the Fleet, effectively disallowing + any inbound client connections that are presenting it. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Key credential in the Fleet. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the given properties of a specific Key credential in the + Fleet, giving it a friendly name or assigning to a Device. + parameters: + - description: '' + in: path + name: FleetSid + required: true + schema: + type: string + - description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DeviceSid: + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + maxLength: 34 + minLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id005 + x-path-type: instance + /DeployedDevices/Fleets/{Sid}: + delete: + description: 'Delete a specific Fleet from your account, also destroys all nested + resources: Devices, Deployments, Certificates, Keys.' + parameters: + - description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch information about a specific Fleet in your account. + parameters: + - description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update the friendly name property of a specific Fleet in your account. + parameters: + - description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + DefaultDeploymentSid: + description: Provides a string identifier of a Deployment that is + going to be used as a default one for this Fleet. + maxLength: 34 + minLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + type: string + FriendlyName: + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id006 + x-path-type: instance + /HostedNumbers/AuthorizationDocuments: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. + parameters: + - description: Email that this AuthorizationDocument will be sent to for signing. + in: query + name: Email + schema: + type: string + - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + in: query + name: Status + schema: + enum: + - opened + - signing + - signed + - canceled + - failed + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AddressSid: + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + CcEmails: + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + items: + type: string + type: array + ContactPhoneNumber: + description: The contact phone number of the person authorized to + sign the Authorization Document. + type: string + ContactTitle: + description: The title of the person authorized to sign the Authorization + Document for this phone number. + type: string + Email: + description: Email that this AuthorizationDocument will be sent + to for signing. + type: string + HostedNumberOrderSids: + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + items: + type: string + type: array + required: + - HostedNumberOrderSids + - AddressSid + - Email + - ContactTitle + - ContactPhoneNumber + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id007 [] + x-path-type: list + /HostedNumbers/AuthorizationDocuments/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific AuthorizationDocument. + parameters: + - description: A 34 character string that uniquely identifies this AuthorizationDocument. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates a specific AuthorizationDocument. + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AddressSid: + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + CcEmails: + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + items: + type: string + type: array + ContactPhoneNumber: + description: The contact phone number of the person authorized to + sign the Authorization Document. + type: string + ContactTitle: + description: The title of the person authorized to sign the Authorization + Document for this phone number. + type: string + Email: + description: Email that this AuthorizationDocument will be sent + to for signing. + type: string + HostedNumberOrderSids: + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + items: + type: string + type: array + 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/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + enum: + - opened + - signing + - signed + - canceled + - failed + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id007 + x-path-type: instance + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. + parameters: + - description: '' + in: path + name: SigningDocumentSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + type: string + - 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/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + in: query + name: Status + schema: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + - description: An E164 formatted phone number hosted by this HostedNumberOrder. + in: query + name: PhoneNumber + schema: + type: string + - description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + in: query + name: IncomingPhoneNumberSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + - description: A human readable description of this resource, up to 64 characters. + in: query + name: FriendlyName + schema: + 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. + in: query + name: UniqueName + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: list + /HostedNumbers/HostedNumberOrders: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. + parameters: + - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. + in: query + name: Status + schema: + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + - description: An E164 formatted phone number hosted by this HostedNumberOrder. + in: query + name: PhoneNumber + schema: + type: string + - description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + in: query + name: IncomingPhoneNumberSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + - description: A human readable description of this resource, up to 64 characters. + in: query + name: FriendlyName + schema: + 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. + in: query + name: UniqueName + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Host a phone number's capability on Twilio's platform. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AccountSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + type: string + AddressSid: + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + maxLength: 34 + minLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + type: string + CcEmails: + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + items: + type: string + type: array + Email: + description: Optional. Email of the owner of this phone number that + is being hosted. + type: string + FriendlyName: + description: A 64 character string that is a human readable text + that describes this resource. + type: string + PhoneNumber: + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + type: string + SmsApplicationSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + type: string + SmsCapability: + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + type: boolean + SmsFallbackMethod: + 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. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsFallbackUrl: + 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. + format: uri + type: string + SmsMethod: + 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. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsUrl: + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + format: uri + type: string + StatusCallbackMethod: + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + StatusCallbackUrl: + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + format: uri + type: string + UniqueName: + 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. + type: string + VerificationDocumentSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + VerificationType: + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + enum: + - phone-call + - phone-bill + type: string + required: + - PhoneNumber + - SmsCapability + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id008 [] + x-path-type: list + /HostedNumbers/HostedNumberOrders/{Sid}: + delete: + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). + parameters: + - description: A 34 character string that uniquely identifies this HostedNumberOrder. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific HostedNumberOrder. + parameters: + - description: A 34 character string that uniquely identifies this HostedNumberOrder. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates a specific HostedNumberOrder. + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallDelay: + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. + type: integer + CcEmails: + description: Optional. A list of emails that LOA document for this + HostedNumberOrder will be carbon copied to. + items: + type: string + type: array + Email: + description: Email of the owner of this phone number that is being + hosted. + type: string + Extension: + description: Digits to dial after connecting the verification call. + type: string + FriendlyName: + description: A 64 character string that is a human readable text + that describes this resource. + type: string + 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. + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + type: string + UniqueName: + 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. + type: string + VerificationCode: + description: A verification code that is given to the user via a + phone call to the phone number that is being hosted. + type: string + VerificationDocumentSid: + 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. + maxLength: 34 + minLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + type: string + VerificationType: + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + enum: + - phone-call + - phone-bill + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id008 + x-path-type: instance + /Sync/Services: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + services: + items: + $ref: '#/components/schemas/preview.sync.service' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AclEnabled: + description: '' + type: boolean + FriendlyName: + description: '' + type: string + ReachabilityWebhooksEnabled: + description: '' + type: boolean + WebhookUrl: + description: '' + format: uri + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id017 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Documents: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + documents: + items: + $ref: '#/components/schemas/preview.sync.service.document' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id010 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Permissions applying to a Sync Document. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + permissions: + items: + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id009 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + delete: + description: Delete a specific Sync Document Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Sync Document Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an identity's access to a specific Sync Document. + parameters: + - description: The unique SID identifier of the Sync Service Instance. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Document. Either a SID or a unique name. + in: path + name: DocumentSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Manage: + description: Boolean flag specifying whether the identity can delete + the Sync Document. + type: boolean + Read: + description: Boolean flag specifying whether the identity can read + the Sync Document. + type: boolean + Write: + description: Boolean flag specifying whether the identity can update + the Sync Document. + type: boolean + required: + - Read + - Write + - Manage + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id009 + x-path-type: instance + /Sync/Services/{ServiceSid}/Documents/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id010 + x-path-type: instance + /Sync/Services/{ServiceSid}/Lists: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + lists: + items: + $ref: '#/components/schemas/preview.sync.service.sync_list' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id013 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: query + name: Order + schema: + enum: + - asc + - desc + type: string + - description: '' + in: query + name: From + schema: + type: string + - description: '' + in: query + name: Bounds + schema: + enum: + - inclusive + - exclusive + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id011 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: path + name: Index + required: true + schema: + type: integer + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: path + name: Index + required: true + schema: + type: integer + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: ListSid + required: true + schema: + type: string + - description: '' + in: path + name: Index + required: true + schema: + type: integer + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id011 + x-path-type: instance + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Permissions applying to a Sync List. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + permissions: + items: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id012 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + delete: + description: Delete a specific Sync List Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Sync List Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an identity's access to a specific Sync List. + parameters: + - description: The unique SID identifier of the Sync Service Instance. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync List. Either a SID or a unique name. + in: path + name: ListSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Manage: + description: Boolean flag specifying whether the identity can delete + the Sync List. + type: boolean + Read: + description: Boolean flag specifying whether the identity can read + the Sync List. + type: boolean + Write: + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync List. + type: boolean + required: + - Read + - Write + - Manage + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id012 + x-path-type: instance + /Sync/Services/{ServiceSid}/Lists/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id013 + x-path-type: instance + /Sync/Services/{ServiceSid}/Maps: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + maps: + items: + $ref: '#/components/schemas/preview.sync.service.sync_map' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + UniqueName: + description: '' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id016 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: query + name: Order + schema: + enum: + - asc + - desc + type: string + - description: '' + in: query + name: From + schema: + type: string + - description: '' + in: query + name: Bounds + schema: + enum: + - inclusive + - exclusive + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + items: + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + Key: + description: '' + type: string + required: + - Key + - Data + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id014 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: path + name: Key + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: path + name: Key + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: MapSid + required: true + schema: + type: string + - description: '' + in: path + name: Key + required: true + schema: + type: string + - description: The If-Match HTTP request header + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Data: + description: '' + type: object + required: + - Data + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id014 + x-path-type: instance + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of all Permissions applying to a Sync Map. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + permissions: + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id015 [] + x-path-type: list + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + delete: + description: Delete a specific Sync Map Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Sync Map Permission. + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an identity's access to a specific Sync Map. + parameters: + - description: The unique SID identifier of the Sync Service Instance. + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: Identifier of the Sync Map. Either a SID or a unique name. + in: path + name: MapSid + required: true + schema: + type: string + - description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + in: path + name: Identity + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Manage: + description: Boolean flag specifying whether the identity can delete + the Sync Map. + type: boolean + Read: + description: Boolean flag specifying whether the identity can read + the Sync Map. + type: boolean + Write: + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync Map. + type: boolean + required: + - Read + - Write + - Manage + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id015 + x-path-type: instance + /Sync/Services/{ServiceSid}/Maps/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: ServiceSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id016 + x-path-type: instance + /Sync/Services/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AclEnabled: + description: '' + type: boolean + FriendlyName: + description: '' + type: string + ReachabilityWebhooksEnabled: + description: '' + type: boolean + WebhookUrl: + description: '' + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id017 + x-path-type: instance + /TrustedComms/BrandedChannels/{BrandedChannelSid}/Channels: + description: 'TODO: Resource-level docs' + post: + description: Associate a channel to a branded channel + parameters: + - description: The unique SID identifier of the Branded Channel. The given phone + number is going to be assigned to this Branded Channel + in: path + name: BrandedChannelSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + PhoneNumberSid: + description: The unique SID identifier of the Phone Number of the + Phone number to be assigned to the Branded Channel. + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + required: + - PhoneNumberSid + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.branded_channel.channel' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - business_sid + - brand_sid + - branded_channel_sid + - phone_number_sid + - phone_number + - url + x-path-type: list + /TrustedComms/BrandedChannels/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Branded Channel. + parameters: + - description: The unique SID identifier of the Branded Channel. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.branded_channel' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - business_sid + - brand_sid + - sid + - links + - url + x-path-type: instance + /TrustedComms/BrandsInformation: + description: 'TODO: Resource-level docs' + get: + description: Retrieve the newest available BrandInformation + parameters: + - description: The If-None-Match HTTP request header + in: header + name: If-None-Match + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.brands_information' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - update_time + - file_link + - file_link_ttl_in_seconds + - url + x-path-type: instance + /TrustedComms/Business/BrandedCalls: + description: 'TODO: Resource-level docs' + post: + description: Brands a Call without actually placing it. Useful for cases when + the Customer wants to initiate the call themselves right after calling this + endpoint. This can be used also through a TwiML using `+1500456`, + and right after doing `+1500456` + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallSid: + description: The Call sid this Branded Call should link to. + maxLength: 34 + minLength: 34 + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + From: + description: The phone number to use as the caller id, given in + [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + It must be a Twilio number that has been set up as a Branded Number + in the Business Profile section for your account. + type: string + Reason: + description: The business reason for this phone call that will appear + in the terminating device's screen. Max 50 characters. + type: string + To: + description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + type: string + required: + - From + - To + - Reason + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.branded_call' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - bg_color + - brand_sid + - branded_channel_sid + - business_sid + - call_sid + - caller + - created_at + - font_color + - from + - logo + - phone_number_sid + - reason + - sid + - status + - to + - url + - use_case + x-path-type: list + /TrustedComms/Business/PhoneCalls: + description: 'TODO: Resource-level docs' + post: + description: Initiates a Branded Call. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + ApplicationSid: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + maxLength: 34 + minLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + type: string + CallerId: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + FallbackMethod: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + FallbackUrl: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + format: uri + type: string + From: + description: The phone number to use as the caller id, given in + [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + It must be a Twilio number that has been set up as a Branded Number + in the Business Profile section for your account. + type: string + MachineDetection: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + MachineDetectionSilenceTimeout: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + MachineDetectionSpeechEndThreshold: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + MachineDetectionSpeechThreshold: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + MachineDetectionTimeout: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + Method: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Reason: + description: The business reason for this phone call that will appear + in the terminating device's screen. Max 50 characters. + type: string + Record: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: boolean + RecordingChannels: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + RecordingStatusCallback: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + RecordingStatusCallbackEvent: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + items: + type: string + type: array + RecordingStatusCallbackMethod: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SendDigits: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + SipAuthPassword: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + SipAuthUsername: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + StatusCallback: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + format: uri + type: string + StatusCallbackEvent: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + items: + type: string + type: array + StatusCallbackMethod: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + Timeout: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: integer + To: + description: The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + type: string + Trim: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + type: string + Url: + description: Refers to the parameter with the same name when [initiating + a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource) + format: uri + type: string + required: + - From + - To + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.phone_call' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - bg_color + - brand_sid + - branded_channel_sid + - business_sid + - call_sid + - caller + - created_at + - font_color + - from + - logo + - phone_number_sid + - reason + - sid + - status + - to + - url + - use_case + x-path-type: list + /TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Impressions Rate. + parameters: + - description: The unique SID identifier of the Business to filter by. + in: path + name: BusinessSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + - description: The unique SID identifier of the Brand to filter by. + in: query + name: BrandSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^BZ[0-9a-fA-F]{32}$ + type: string + - description: The unique SID identifier of the Branded Channel to filter by. + in: query + name: BrandedChannelSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^BW[0-9a-fA-F]{32}$ + type: string + - description: The unique SID identifier of the Phone Number to filter by. + in: query + name: PhoneNumberSid + schema: + maxLength: 34 + minLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + type: string + - description: The 2-letter ISO 3166 code of the Country to filter by. + in: query + name: Country + schema: + type: string + - description: The start date that for this Impressions Rate, given in ISO 8601 + format. Default value is 30 days ago. + in: query + name: Start + schema: + format: date-time + type: string + - description: The end date that for this Impressions Rate, given in ISO 8601 + format. Default value is current timestamp. + in: query + name: End + schema: + format: date-time + type: string + - description: The Interval of this Impressions Rate. One of `minute`, `hour`, + `day`, `week` or `month`. + in: query + name: Interval + schema: + enum: + - minute + - hour + - day + - week + - month + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - start + - end + - interval + - business_sid + - reports + - url + x-path-type: instance + /TrustedComms/Businesses/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Business. + parameters: + - description: A 34 character string that uniquely identifies this Business. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^BX[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.business' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - account_sid + - sid + - url + - links + x-path-type: instance + /TrustedComms/CPS: + description: 'TODO: Resource-level docs' + get: + description: Fetch a specific Call Placement Service (CPS) given a phone number + via `X-XCNAM-Sensitive-Phone-Number` header. + parameters: + - description: The X-Xcnam-Sensitive-Phone-Number HTTP request header + in: header + name: X-Xcnam-Sensitive-Phone-Number + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.cps' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - cps_url + - phone_number + - url + x-path-type: instance + /TrustedComms/CurrentCall: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a current call given the originating and terminating number + via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` + headers. + parameters: + - description: The X-Xcnam-Sensitive-Phone-Number-From HTTP request header + in: header + name: X-Xcnam-Sensitive-Phone-Number-From + schema: + type: string + - description: The X-Xcnam-Sensitive-Phone-Number-To HTTP request header + in: header + name: X-Xcnam-Sensitive-Phone-Number-To + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.trusted_comms.current_call' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: + - bg_color + - caller + - created_at + - font_color + - from + - logo + - manager + - reason + - shield_img + - sid + - status + - to + - url + - use_case + x-path-type: instance + /marketplace/AvailableAddOns: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Add-ons currently available to be installed. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + available_add_ons: + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id019 [] + x-path-type: list + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Extensions for the Available Add-on. + parameters: + - description: The SID of the AvailableAddOn resource with the extensions to + read. + in: path + name: AvailableAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + extensions: + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id018 [] + x-path-type: list + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Extension for the Available Add-on. + parameters: + - description: The SID of the AvailableAddOn resource with the extension to + fetch. + in: path + name: AvailableAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + - description: The SID of the AvailableAddOn Extension resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id018 + x-path-type: instance + /marketplace/AvailableAddOns/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Add-on currently available to be installed. + parameters: + - description: The SID of the AvailableAddOn resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id019 + x-path-type: instance + /marketplace/InstalledAddOns: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Add-ons currently installed on this Account. + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + installed_add_ons: + items: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Install an Add-on for the Account specified. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + AcceptTermsOfService: + description: Whether the Terms of Service were accepted. + type: boolean + AvailableAddOnSid: + description: The SID of the AvaliableAddOn to install. + maxLength: 34 + minLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + type: string + Configuration: + description: The JSON object that represents the configuration of + the new Add-on being installed. + type: object + UniqueName: + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + type: string + required: + - AvailableAddOnSid + - AcceptTermsOfService + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id021 [] + x-path-type: list + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + description: 'TODO: Resource-level docs' + get: + description: Retrieve a list of Extensions for the Installed Add-on. + parameters: + - description: The SID of the InstalledAddOn resource with the extensions to + read. + in: path + name: InstalledAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + extensions: + items: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id020 [] + x-path-type: list + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Extension for the Installed Add-on. + parameters: + - description: The SID of the InstalledAddOn resource with the extension to + fetch. + in: path + name: InstalledAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + - description: The SID of the InstalledAddOn Extension resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an Extension for an Add-on installation. + parameters: + - description: The SID of the InstalledAddOn resource with the extension to + update. + in: path + name: InstalledAddOnSid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + - description: The SID of the InstalledAddOn Extension resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Enabled: + description: Whether the Extension should be invoked. + type: boolean + required: + - Enabled + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id020 + x-path-type: instance + /marketplace/InstalledAddOns/{Sid}: + delete: + description: Remove an Add-on installation from your account + parameters: + - description: The SID of the InstalledAddOn resource to delete. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: Fetch an instance of an Add-on currently installed on this Account. + parameters: + - description: The SID of the InstalledAddOn resource to fetch. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Update an Add-on installation for the Account specified. + parameters: + - description: The SID of the InstalledAddOn resource to update. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + 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 + type: object + UniqueName: + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id021 + x-path-type: instance + /understand/Assistants: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + assistants: + items: + $ref: '#/components/schemas/preview.understand.assistant' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackEvents: + description: Space-separated list of callback events that will trigger + callbacks. + type: string + CallbackUrl: + description: A user-provided URL to send event callbacks to. + format: uri + type: string + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + type: object + FriendlyName: + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + type: string + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + type: object + LogQueries: + description: A boolean that specifies whether queries should be + logged for 30 days further training. If false, no queries will + be stored, if true, queries will be stored for 30 days and deleted + thereafter. Defaults to true if no value is provided. + type: boolean + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + type: object + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id029 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.dialogue' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/FallbackActions: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FallbackActions: + description: '' + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/FieldTypes: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + field_types: + items: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - UniqueName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id023 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + - description: 'An ISO language-country string of the value. For example: *en-US*' + in: query + name: Language + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + field_values: + items: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Language: + description: An ISO language-country string of the value. + type: string + SynonymOf: + description: A value that indicates this field value is a synonym + of. Empty if the value is not a synonym. + type: string + Value: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - Language + - Value + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id022 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: FieldTypeSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id022 + x-path-type: instance + /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id023 + x-path-type: instance + /understand/Assistants/{AssistantSid}/InitiationActions: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + InitiationActions: + description: '' + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/ModelBuilds: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + model_builds: + items: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + StatusCallback: + description: '' + format: uri + type: string + UniqueName: + description: 'A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. For example: v0.1' + type: string + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id024 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: AssistantSid + required: true + schema: + type: string + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + UniqueName: + description: 'A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. For example: v0.1' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id024 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Queries: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: An ISO language-country string of the sample. + in: query + name: Language + schema: + type: string + - description: The Model Build Sid or unique name of the Model Build to be queried. + in: query + name: ModelBuild + schema: + type: string + - description: 'A string that described the query status. The values can be: + pending_review, reviewed, discarded' + in: query + name: Status + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + queries: + items: + $ref: '#/components/schemas/preview.understand.assistant.query' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Field: + description: Constraints the query to a given Field with an task. + Useful when you know the Field you are expecting. It accepts one + field in the format *task-unique-name-1*:*field-unique-name* + type: string + Language: + description: An ISO language-country string of the sample. + type: string + ModelBuild: + description: The Model Build Sid or unique name of the Model Build + to be queried. + type: string + Query: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. It can be up to 2048 characters + long. + type: string + Tasks: + description: Constraints the query to a set of tasks. Useful when + you need to constrain the paths the user can take. Tasks should + be comma separated *task-unique-name-1*, *task-unique-name-2* + type: string + required: + - Language + - Query + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id025 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Queries/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + SampleSid: + description: An optional reference to the Sample created from this + query. + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + Status: + description: 'A string that described the query status. The values + can be: pending_review, reviewed, discarded' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id025 + x-path-type: instance + /understand/Assistants/{AssistantSid}/StyleSheet: + description: 'TODO: Resource-level docs' + get: + description: Returns Style sheet JSON object for this Assistant + parameters: + - description: The unique ID of the Assistant + in: path + name: AssistantSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates the style sheet for an assistant identified by {AssistantSid} + or {AssistantUniqueName}. + parameters: + - description: The unique ID of the Assistant + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + StyleSheet: + description: The JSON Style sheet string + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + tasks: + items: + $ref: '#/components/schemas/preview.understand.assistant.task' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + type: object + ActionsUrl: + description: User-provided HTTP endpoint where from the assistant + fetches actions + format: uri + type: string + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - UniqueName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id026 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Tasks/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + type: object + ActionsUrl: + description: User-provided HTTP endpoint where from the assistant + fetches actions + format: uri + type: string + FriendlyName: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id026 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: + description: 'TODO: Resource-level docs' + get: + description: Returns JSON actions for this Task. + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task. + in: path + name: TaskSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task. + in: path + name: TaskSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Actions: + description: The JSON actions that instruct the Assistant how to + perform this task. + type: object + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + fields: + items: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FieldType: + description: The unique name or sid of the FieldType. It can be + any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) + or the unique_name or the Field Type sid of a custom Field Type. + type: string + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + required: + - FieldType + - UniqueName + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id027 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id027 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: An ISO language-country string of the sample. + in: query + name: Language + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + samples: + items: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Language: + description: An ISO language-country string of the sample. + type: string + SourceChannel: + description: 'The communication channel the sample was captured. + It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, + or *slack*. If not included the value will be null' + type: string + TaggedText: + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + type: string + required: + - Language + - TaggedText + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id028 [] + x-path-type: list + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: + delete: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: The unique ID of the Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Sample. + in: path + name: TaskSid + required: true + schema: + type: string + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + Language: + description: An ISO language-country string of the sample. + type: string + SourceChannel: + description: 'The communication channel the sample was captured. + It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, + or *slack*. If not included the value will be null' + type: string + TaggedText: + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id028 + x-path-type: instance + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: The unique ID of the parent Assistant. + in: path + name: AssistantSid + required: true + schema: + type: string + - description: The unique ID of the Task associated with this Field. + in: path + name: TaskSid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance + /understand/Assistants/{Sid}: + delete: + description: '' + parameters: + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: A 34 character string that uniquely identifies this resource. + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackEvents: + description: Space-separated list of callback events that will trigger + callbacks. + type: string + CallbackUrl: + description: A user-provided URL to send event callbacks to. + format: uri + type: string + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + type: object + FriendlyName: + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + type: string + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + type: object + LogQueries: + description: A boolean that specifies whether queries should be + logged for 30 days further training. If false, no queries will + be stored, if true, queries will be stored for 30 days and deleted + thereafter. Defaults to true if no value is provided. + type: boolean + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + type: object + UniqueName: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id029 + x-path-type: instance + /wireless/Commands: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: query + name: Device + schema: + type: string + - description: '' + in: query + name: Sim + schema: + type: string + - description: '' + in: query + name: Status + schema: + type: string + - description: '' + in: query + name: Direction + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + commands: + items: + $ref: '#/components/schemas/preview.wireless.command' + type: array + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackMethod: + description: '' + type: string + CallbackUrl: + description: '' + format: uri + type: string + Command: + description: '' + type: string + CommandMode: + description: '' + type: string + Device: + description: '' + type: string + IncludeSid: + description: '' + type: string + Sim: + description: '' + type: string + required: + - Command + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.command' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id030 [] + x-path-type: list + /wireless/Commands/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + maxLength: 34 + minLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.command' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id030 + x-path-type: instance + /wireless/RatePlans: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + rate_plans: + items: + $ref: '#/components/schemas/preview.wireless.rate_plan' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CommandsEnabled: + description: '' + type: boolean + DataEnabled: + description: '' + type: boolean + DataLimit: + description: '' + type: integer + DataMetering: + description: '' + type: string + FriendlyName: + description: '' + type: string + InternationalRoaming: + description: '' + items: + type: string + type: array + MessagingEnabled: + description: '' + type: boolean + NationalRoamingEnabled: + description: '' + type: boolean + UniqueName: + description: '' + type: string + VoiceEnabled: + description: '' + type: boolean + type: object + responses: + 201: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + description: Created + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id031 [] + x-path-type: list + /wireless/RatePlans/{Sid}: + delete: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 204: + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + tags: + - Preview + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + FriendlyName: + description: '' + type: string + UniqueName: + description: '' + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id031 + x-path-type: instance + /wireless/Sims: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: query + name: Status + schema: + type: string + - description: '' + in: query + name: Iccid + schema: + type: string + - description: '' + in: query + name: RatePlan + schema: + type: string + - description: '' + in: query + name: EId + schema: + type: string + - description: '' + in: query + name: SimRegistrationCode + schema: + type: string + - description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + in: query + name: PageSize + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + 200: + content: + application/json: + schema: + properties: + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + type: string + url: + format: uri + type: string + type: object + sims: + items: + $ref: '#/components/schemas/preview.wireless.sim' + type: array + type: object + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: &id032 [] + x-path-type: list + /wireless/Sims/{Sid}: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + post: + description: '' + parameters: + - description: '' + in: path + name: Sid + required: true + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + properties: + CallbackMethod: + description: '' + type: string + CallbackUrl: + description: '' + format: uri + type: string + CommandsCallbackMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + CommandsCallbackUrl: + description: '' + format: uri + type: string + FriendlyName: + description: '' + type: string + RatePlan: + description: '' + type: string + SmsFallbackMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsFallbackUrl: + description: '' + format: uri + type: string + SmsMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + SmsUrl: + description: '' + format: uri + type: string + Status: + description: '' + type: string + UniqueName: + description: '' + type: string + VoiceFallbackMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + VoiceFallbackUrl: + description: '' + format: uri + type: string + VoiceMethod: + description: '' + enum: + - head + - get + - post + - patch + - put + - delete + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + type: string + VoiceUrl: + description: '' + format: uri + type: string + type: object + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: *id032 + x-path-type: instance + /wireless/Sims/{SimSid}/Usage: + description: 'TODO: Resource-level docs' + get: + description: '' + parameters: + - description: '' + in: path + name: SimSid + required: true + schema: + type: string + - description: '' + in: query + name: End + schema: + type: string + - description: '' + in: query + name: Start + schema: + type: string + responses: + 200: + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim.usage' + description: OK + security: + - accountSid_authToken: [] + tags: + - Preview + servers: + - url: https://preview.twilio.com + x-default-output-properties: [] + x-path-type: instance +tags: +- description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact help@twilio.com. + name: Preview